Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baires/shouldideploy
Source of shouldideploy.today
https://github.com/baires/shouldideploy
Last synced: 2 months ago
JSON representation
Source of shouldideploy.today
- Host: GitHub
- URL: https://github.com/baires/shouldideploy
- Owner: baires
- License: wtfpl
- Created: 2017-03-06T19:14:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T13:58:48.000Z (3 months ago)
- Last Synced: 2024-10-28T17:10:55.399Z (2 months ago)
- Language: TypeScript
- Homepage: https://shouldideploy.today/
- Size: 5.64 MB
- Stars: 417
- Watchers: 5
- Forks: 79
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-starts - baires/shouldideploy - Source of shouldideploy.today (others)
README
# shouldideploy.today
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fbaires%2Fshouldideploy?ref=badge_shield)
## Getting started
* Run:
* `npm i` — install deps.
* `npm run dev` start dev server
* `now dev` if you need local serveless function (requires now)
[](https://gitpod.io/#https://github.com/baires/shouldideploy)
## Add your reasons
Reasons are located under [reasons.ts](https://github.com/baires/shouldideploy/blob/master/helpers/reasons.ts)
## API endpoint
There is an endpoint to use on your CI or just for fun at `https://shouldideploy.today/api`
You can also provide optional parameters to customize the API response:
- `tz`: The timezone to use when evaluating the date and time. The default value is UTC. Pass a valid timezone string, such as `America/New_York` or `Europe/London` default `UTC`.
- `date`: The date to evaluate. The default value is the current date. Pass a valid date string in the format `YYYY-MM-DD`, such as `2023-03-31`.
### Examples
Get the default API response using the current date and time in the UTC timezone:
```
https://shouldideploy.today/api
```
Get the API response for a specific timezone (e.g., Europe/London):
```
https://shouldideploy.today/api?tz=Europe/London
```
Get the API response for a specific date (e.g., 2023-03-31) in the UTC timezone:
```
https://shouldideploy.today/api?date=2023-03-31
```
Get the API response for a specific date (e.g., 2023-03-31) in a specific timezone (e.g., America/New_York):
```
https://shouldideploy.today/api?tz=America/New_York&date=2023-03-31
```
## API Response
The API returns a JSON object containing the following keys:
- `timezone`: The timezone used for evaluating the date and time.
- `date`: The date provided as parameter in ISO format (YYYY-MM-DDTHH:mm:ss.sssZ)
- `shouldideploy`: A boolean value indicating whether you should deploy today or not.
- `message`: A string containing a reason or explanation for the `shouldideploy` result.
Example response:
```
{
"timezone": "UTC",
"date": "2023-03-31T00:00:00.000Z",
"shouldideploy": false,
"message": "It's Friday, better not deploy today."
}
```
## Community projects
- [gustamms/devo-fazer-deploy-hoje](https://github.com/gustamms/devo-fazer-deploy-hoje) Versão brasileira do site https://shouldideploy.today/
- [timelfrink/shouldideploy-action](https://github.com/timelfrink/shouldideploy-action) This action checks the website shouldideploy.today and stops deployments if the site tells us not to do so.
- [panacaqui/should-i-deploy-today-discord-bot](https://github.com/panacaqui/should-i-deploy-today-discord-bot) A simple API to send a daily message from shouldideploy.today in a Discord channel.
- [MatheusHAS/shouldideploytoday-for-pipeline](https://github.com/MatheusHAS/shouldideploytoday-for-pipeline) This example of implementation, consumes the shouldideploy.today API to decide on my pipeline if will be deploy process run or not.
- [Brunomachadob/shouldideploy-slack](https://github.com/Brunomachadob/shouldideploy-slack) Should I Deploy Slack command
- [gpalomar/shouldideploy-vscode](https://github.com/gpalomar/shouldideploy-vscode) A Visual Studio Code Extension that uses https://github.com/baires/shouldideploy 🍻⚠️
## Credits
Favicon created by [emilegraphics](https://thenounproject.com/search/?q=dot&i=1359410)
## License
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fbaires%2Fshouldideploy?ref=badge_large)