Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add releasing.md, fix link #60

Merged
merged 2 commits into from
Aug 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,6 @@ jobs:
What's changed:
* TODO

Get it [here](https://pypi.org/project/${{ github.repository }}/${{ github.ref_name }})
Get it [here](https://pypi.org/project/django-template-lsp/${{ github.ref_name }})
draft: true
files: dist/
12 changes: 12 additions & 0 deletions releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Releasing

To create a new release, follow these steps:

- Update the version number in `djslsp/__init__.py` and push this to `main`.
- We use [semantic](https://semver.org/) versioning.
- Create a new tag and push the tag by push the tag using `git push --tags`.

The release will be automatically built and published to [PyPi](https://pypi.org/project/django-template-lsp/).

After publishing to PyPi, a draft release is automatically made on Github.
Edit this release, include the changes in the "What's changed" section and publish the release.