mirror of
https://codeberg.org/fediverse/fep.git
synced 2026-08-05 03:35:52 +00:00
silverpill
abcdfc4c08
There was a conflict between `create_site_pages.py` and `pytest`. The former added python files to `docs` and `build` directories, causing `pytest scripts` to fail. Reviewed-on: https://codeberg.org/fediverse/fep/pulls/802 Reviewed-by: helge <helge@noreply.codeberg.org> Co-authored-by: silverpill <silverpill@firemail.cc> Co-committed-by: silverpill <silverpill@firemail.cc>
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# tools for fep facilitators
|
|
|
|
Please follow the steps in configuration before following "Merge a FEP".
|
|
|
|
## Merge a FEP
|
|
|
|
Merge the Pull Request in [https://codeberg.org/fediverse/fep/pulls](https://codeberg.org/fediverse/fep/pulls)
|
|
and note the slug.
|
|
|
|
```bash
|
|
./scripts/create_issue.py $SLUG
|
|
```
|
|
|
|
creates the tracking issue and updates the FEP with the information.
|
|
Then run
|
|
|
|
```bash
|
|
./scripts/create_readme.py
|
|
```
|
|
|
|
to update the table in `README.md`. You are now ready to commit the
|
|
changes to the FEP (added `trackingIssue` to frontmatter) and README.md,
|
|
added the new FEP.
|
|
|
|
## Configuration
|
|
|
|
Add a file `config.json` to the directory `scripts` with content
|
|
|
|
```json
|
|
{
|
|
"repo": "fep",
|
|
"owner": "fediverse",
|
|
"token": "CODEBERG_API_TOKEN"
|
|
}
|
|
```
|
|
|
|
The API token can be obtained by visiting [https://codeberg.org/user/settings/applications](https://codeberg.org/user/settings/applications) and generating one with scope `write:issue`.
|
|
|
|
## Setup for running pytest
|
|
|
|
Ensure dependencies (use a virtualenv)
|
|
|
|
```bash
|
|
pip install pytest
|
|
```
|
|
|
|
Check validity
|
|
|
|
```bash
|
|
pytest scripts/
|
|
```
|