Skip to content

Commit b8f3238

Browse files
docs: finish CI/CD pipelines
1 parent 1918666 commit b8f3238

File tree

4 files changed

+37
-6
lines changed

4 files changed

+37
-6
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,20 @@ First-time maintainers must learn multiple tools and concepts, e.g. [MyST], [Sem
5555
<img alt="Project Website" src="afterpython/static/website-light.png">
5656
</picture>
5757
58+
You can create your own website too and deploy it to GitHub Pages in **less than a minute**! See [Quickstart](https://afterpython.afterpython.org/doc/quickstart).
59+
5860
---
5961
## Installation
6062
```bash
6163
# install afterpython as a dev dependency
6264
uv add --dev afterpython
65+
6366
# initialize afterpython
6467
ap init
6568
```
6669

6770

71+
---
6872
## Tech Stack
6973
- [MyST]
7074
- [project-website-template]
@@ -78,3 +82,8 @@ ap init
7882
- [WebLLM]
7983
<!-- - ty -->
8084
<!-- - [pixi] -->
85+
86+
87+
---
88+
## *Mission*
89+
> Only by making package maintenance and documentation easy can we encourage more Python developers to publish their own packages and grow the ecosystem even further.
Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
[pre-commit]: https://github.com/pre-commit/pre-commit
1+
[PyPI]: https://pypi.org/
22

33
# CI/CD Pipelines
4+
Currently, `afterpython` only supports GitHub Actions for CI/CD pipelines.
45

5-
## `pre-commit`
6+
## GitHub Actions
7+
Inside `.github/workflows/`, you'll find the following workflows:
68

7-
## `ruff`
9+
### `release.yml`
10+
Releases your package to [PyPI] and GitHub.
811

12+
See [PyPI and GitHub Releases](./release_management.md#pypi-and-github-releases) for more details.
913

10-
## GitHub Actions
14+
### `deploy.yml`
15+
Deploys your project website to GitHub Pages.
16+
17+
---
18+
## Security Scanning 🚧
19+
20+
---
21+
## Code Coverage 🚧
1122

12-
## GitHub Dependabots 🚧
23+
---
24+
## GitHub Dependabot 🚧

afterpython/doc/package_maintenance/release_management.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,13 @@
88
- `ap release`
99

1010

11+
---
1112
## PyPI and GitHub Releases
13+
14+
15+
---
16+
## Semantic Release 🚧
17+
18+
19+
---
20+
## Changlog 🚧

afterpython/doc/references/roadmap.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ This roadmap is tentative and subject to change
55
```
66

77
- integrate with `pdoc` for API reference generation
8+
- convert blog posts to format compatible with medium.com and substack.com
89
- AI chatbot like kapa.ai using WebLLM
910
- full-text search engine using pagefind
1011
- incremental build, only build changed content (for `ap dev`)
11-
- github dependabots
12+
- github dependabot
1213
- integrate with `git-cliff` for changelog generation
1314
- integrate with `pixi`, supports `conda install`
1415
- supports docs built by different engines? e.g. Sphix, MkDocs

0 commit comments

Comments
 (0)