-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Md Soharab Ansari <[email protected]>
- Loading branch information
1 parent
56d917c
commit 1531456
Showing
3 changed files
with
58 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Tools | ||
|
||
- `environments.py` updates `static/data/environments.json`. | ||
- `notes.py` generates content for changelog section in release notes. | ||
|
||
## Environments | ||
### Updating the existing environments | ||
Copy [environments.json](https://github.com/fission/environments/blob/master/environments.json) from [environments](https://github.com/fission/environments/tree/master) repository to `tools/` directory. | ||
|
||
Update the `static/data/environments.json` by running the command: | ||
``` | ||
python3 environments.py | ||
``` | ||
|
||
### Adding a new environment | ||
Add static data for new environment to `static/data/environments.json`: | ||
Ex: For FastAPI environment | ||
``` | ||
{ | ||
"name": "Python (FastAPI)", | ||
"logo": "/images/lang-logo/python-logo.svg", | ||
"repo": "https://github.com/fission/environments/tree/master/python-fastapi", | ||
"images": [] | ||
}, | ||
``` | ||
|
||
Add a key-value pair for new environment to `environments.py` `env_dict` dictionary. | ||
Where key is the name of new environment in [environments.json](https://github.com/fission/environments/blob/master/environments.json) and | ||
value is the name for new environment in `static/data/environments.json`. | ||
``` | ||
Python FastAPI Environment: Python (FastAPI) | ||
``` | ||
|
||
Now, run the script. | ||
``` | ||
python3 environments.py | ||
``` | ||
|
||
## ChangeLog | ||
Copy the changelog section from draft release to a file `notes.txt`. | ||
Run `notes.py` on it. | ||
``` | ||
python3 notes.py | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters