Note
When you include the release date in the format _YYYY-MM-DD_, it will be displayed in the release notes.
See docs/scripts/gen_release_notes.py for more details.
Note
When you include the release date in the format _YYYY-MM-DD_, it will be displayed in the release notes.
See docs/scripts/gen_release_notes.py for more details.
Create a new PR to merge the changes above into the master branch.
Create new release in Github UI.
We use Semantic Versioning for django-components.
The version number is in the format MAJOR.MINOR.PATCH (e.g. 0.141.6).
MAJOR (e.g. 1.0.0) is reserved for significant architectural changes and breaking changes.MINOR (e.g. 0.1.0) is incremented for new features.PATCH (e.g. 0.0.1) is incremented for bug fixes or documentation changes.Head over to Dev guides for a deep dive into how django_components' features are implemented.
The scripts/supported_versions.py script can be used to update the supported versions.
This will check the current versions of Django and Python, and will print to the terminal all the places that need updating and what to set them to.
The scripts/validate_links.py script can be used to update the link references.
Note
When you include the release date in the format _YYYY-MM-DD_, it will be displayed in the release notes.
See docs/scripts/gen_release_notes.py for more details.
Create a new PR to merge the changes above into the master branch.
Create new release in Github UI.
We use Semantic Versioning for django-components.
The version number is in the format MAJOR.MINOR.PATCH (e.g. 0.141.6).
MAJOR (e.g. 1.0.0) is reserved for significant architectural changes and breaking changes.MINOR (e.g. 0.1.0) is incremented for new features.PATCH (e.g. 0.0.1) is incremented for bug fixes or documentation changes.Head over to Dev guides for a deep dive into how django_components' features are implemented.
The scripts/supported_versions.py script manages the supported Python and Django versions for the project.
The script runs automatically via GitHub Actions once a week to check for version updates. If changes are detected, it creates a GitHub issue with the necessary updates. See the maint-supported-versions.yml workflow.
You can also run the script manually:
# Check if versions need updating
+python scripts/supported_versions.py check
+
+# Generate configuration snippets for manual updates
+python scripts/supported_versions.py generate
+The generate command will print to the terminal all the places that need updating and what to set them to.
The scripts/validate_links.py script can be used to update the link references.
When new version of Django is released, you can use the script to update the URLs pointing to the Django documentation.
First, you need to update the URL_REWRITE_MAP in the script to point to the new version of Django.
Then, you can run the script to update the URLs in the codebase.
We use the GitHub project board to manage the project.
Quick overview of the columns:
New issues are automatically added to the No status column.
To pick up an issue, assign it to yourself and move it to the 🟡 In Progress column.
Use the sidebar to filter the issues by different labels, milestones, and issue types:
Which issues should be picked up first?
We suggest the following guideline:
After that, pick what you like!
Labels help keep our project organized. See the list of all labels here.
milestone--v1 - Work to be done for the V1 release.type--bug - Bugs.type--documentation - Documentation changes.type--enhancement - New features and improvements.type--integration - Integrating with other libraries or systems.type--operations - Relating to "operations" - Github Actions, processes, etc.type--optimisation - Optimizing the code for performance.