Skip to content

Commit 81c73ef

Browse files
Prepare for release (#86)
* Update README.md * Update README.md * Update test.yaml * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 872694a commit 81c73ef

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

.github/workflows/test.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ jobs:
3232
--verbose
3333
- name: Upload coverage to Codecov
3434
uses: codecov/codecov-action@v3
35-
with:
36-
token: ${{ secrets.CODECOV_TOKEN }}
3735

3836
ruff:
3937
runs-on: ubuntu-latest

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# CMI-DAIR Template Python Repository
22

3-
This is a template repository. Below is a checklist of things you should do to use it:
3+
Welcome to the CMI-DAIR Template Python Repository! This template is designed to streamline your project setup and ensure a consistent structure. To get started, follow these steps:
44

5-
- [ ] Run `setup_template.py` to set up the repository.
6-
- [ ] Rewrite this `README` file.
7-
- [ ] Install the `pre-commit` hooks.
8-
- [ ] Update the `LICENSE` file to your desired license and set the year.
9-
- [ ] Update the supported versions in `SECURITY.md` or, if not relevant, delete this file.
5+
6+
- [ ] Run `setup_template.py` to initialize the repository.
7+
- [ ] Replace the content of this `README.md` with details specific to your project.
8+
- [ ] Install the `pre-commit` hooks to ensure code quality on each commit.
9+
- [ ] Revise SECURITY.md to reflect supported versions or remove it if not applicable.
1010
- [ ] Remove the placeholder src and test files, these are there merely to show how the CI works.
11-
- [ ] Grant third-party app permissions (e.g. Codecov) [here](https://github.com/organizations/cmi-dair/settings/installations), if necessary.
12-
- [ ] Either generate a `CODECOV_TOKEN` secret [here](https://github.com/cmi-dair/flowdump/blob/main/.github/workflows/python_tests.yaml) (if its a private repository) or remove the line `token: ${{ secrets.CODECOV_TOKEN }}`
13-
- [ ] API docs website: After the first successful build, go to the `Settings` tab of your repository, scroll down to the `GitHub Pages` section, and select `gh-pages` as the source. This will generate a link to your API docs.
11+
- [ ] If it hasn't already been done for your organization/acccount, grant third-party app permissions for CodeCov.
12+
- [ ] To set up an API documentation website, after the first successful build, go to the `Settings` tab of your repository, scroll down to the `GitHub Pages` section, and select `gh-pages` as the source. This will generate a link to your API docs.
1413
- [ ] Update stability badge in `README.md` to reflect the current state of the project. A list of stability badges to copy can be found [here](https://github.com/orangemug/stability-badges). The [node documentation](https://nodejs.org/docs/latest-v20.x/api/documentation.html#documentation_stability_index) can be used as a reference for the stability levels.
1514

1615
# Project name

0 commit comments

Comments
 (0)