diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index b7b65e6..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,55 +0,0 @@ -# Changelog - -## Version 0.1.0 - -**Initial Release** - -This release includes the incorporation of the following packages: -- [`QEDbase.jl`](https://github.com/QEDjl-project/QEDbase.jl) -- [`QEDcore.jl`](https://github.com/QEDjl-project/QEDcore.jl) -- [`QEDprocesses.jl`](https://github.com/QEDjl-project/QEDprocesses.jl) -- [`QEDevents.jl`](https://github.com/QEDjl-project/QEDevents.jl) -- [`QEDfields.jl`](https://github.com/QEDjl-project/QEDfields.jl) - -Most of the functionality outside of these packages is concerned with continuous integration workflow files and generating integration tests. - -### New features - -- [#2](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/2): Add QED subpackages as dependencies -- [#3](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/3): Enable unit testing with custom URLs via commit message -- [#4](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/4): Add integration test generation -- [#15](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/15): Add code formatting to CI -- [#20](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/20): Add compat helper to CI -- [#24](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/24): Add documentation build job to CI -- [#41](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/41): Add script to set dependencies to their dev versions in integration tests for PRs to `main` -- [#43](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/43): Add script to determine PR target branch in GitLab CI -- [#44](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/44): Add script to set all dependencies to their `dev` versions -- [#45](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/45): Set dependencies to dev versions in doc building job when target is not main -- [#57](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/57): Correctly handle dev and main branches in `get_target_branch.jl` -- [#58](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/58): Add a template for release issues in QEDjl-project repositories to the docs -- [#62](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/62): Add more documentation for the release process of QEDjl-project repositories -- [#64](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/64): Rename the project and repository to `QuantumElectrodynamics.jl` (previously `QED.jl`, rejected in the general registry because of only 3 letters) - -### Fixes - -- [#5](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/5): Disable custom subpackage URLs in dependent packages on `dev` and `main` branches -- [#10](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/10): Remove Compat helper -- [#14](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/14): Remove `Manifest.toml` since libraries should not rely on this -- [#19](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/19): Use dev branches instead of the registry to build dependency graph for integration tests -- [#25](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/25): Run compat helper only on upstream repositories -- [#31](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/31): Fix integration test generation after dependency updated -- [#32](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/32): Second fix for dependency update, changed overlooked function signature -- [#52](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/52): Fix CI script for docs deployment -- [#53](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/53): Fix stable docs badge link -- [#63](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/63): Fix integration tests for merges to the main branch -- [#66](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/66): Fix regex in `dev_dependencies`, introduced while renaming the project in #64 - -### Maintenance - -- [#11](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/11): Add install instructions -- [#17](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/17): Run unit tests with Julia versions `1.6` to `1.10` and `rc` -- [#26](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/26): Add compat entry for QEDprocesses (`v0.1`) -- [#38](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/38): Remove QEDprocesses compat -- [#39](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/39): Add new package QEDcore.jl to integration test package info -- [#51](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/51): Add Reexport compat entry (v1.2) -- [#60](https://github.com/QEDjl-project/QuantumElectrodynamics.jl/pull/60): Refactoring of `get_target_branch.jl` diff --git a/docs/src/dev_guide.md b/docs/src/dev_guide.md index 12184cc..f05b314 100644 --- a/docs/src/dev_guide.md +++ b/docs/src/dev_guide.md @@ -22,28 +22,16 @@ In case breaking changes are introduced by the pull request the integration test Several steps are involved in releasing a new version of a package. For versioning, we follow [Julia's versioning guidelines](https://julialang.org/blog/2019/08/release-process/). However, we do not provide patches for previous minor or major versions. -### Release Issue Template +### Release Procedure -The following is a template that can be used to open issues for a specific release of one of the QED-project packages. Customize it by simply replacing `` with the version to-be-released. +The following is a description of our release process for a version ``. -```md -With this issue, we keep track of the workflow for version `` release. - -## Preparation for the release - -- [ ] Tag all PRs that are part of this release by adding them to a milestone named `Release-`. -- [ ] Create a release branch `release-` on your fork. -- [ ] Adjust `./Project.toml` on the new `release-` branch by ticking up the version. -- [ ] Check if it is necessary to adjust the `compat` entry of upstream QED-project packages. -- [ ] Add/Update the file `./CHANGELOG.md` on the `release-` branch by appending a summary section. This can be done by using the tagged PRs associated with this release. - -## Release procedure - -- [ ] Open a PR for merging `release-` into the `main`-branch of the QEDjl-project repository with at least one reviewer who only needs to check the points above, the code additions were reviewed in the respective PRs. Do not delete the `release-` branch yet. :warning: **Do not squash this PR, use a simple merge commit** :warning: -- [ ] *After* the release branch is merged into `main`, open another PR for merging `release-` into the `dev`-branch of the QEDjl-project repository. This can be merged without much review because the relevant changes were already reviewed in the PR `release- -> main`. After this merge, you are free to delete the `release-`-branch on your fork. :warning: **Do not squash this PR, use a simple merge commit** :warning: -- [ ] Registration: Go to the issues and search for `Release`. There, write a comment with `JuliaRegistrator register(branch="main")` with a real `@` to trigger the registration bot opening a PR on Julia's general registry. Also add a small general description of the release, so TagBot adds it to the GitHub release later. -- [ ] Once the registration is completed, check that the TagBot correctly tagged the version and built a GitHub release. -``` +- Create a release branch `release-` on your fork. +- Adjust `./Project.toml` on the new `release-` branch by ticking up the version. +- Open a PR for merging `release-` into the `main`-branch of the QEDjl-project repository with at least one reviewer who only needs to check the points above, the code additions were reviewed in the respective PRs. Do not delete the `release-` branch yet. :warning: **Do not squash this PR, use a simple merge commit** :warning: +- *After* the release branch is merged into `main`, open another PR for merging `release-` into the `dev`-branch of the QEDjl-project repository. This can be merged without much review because the relevant changes were already reviewed in the PR `release- -> main`. After this merge, you are free to delete the `release-`-branch on your fork. :warning: **Do not squash this PR, use a simple merge commit** :warning: +- Registration: Go to the issues and search for `Release`. There, write a comment with `@JuliaRegistrator register(branch="main")` to trigger the registration bot opening a PR on Julia's general registry. Also add a small general description of the release, so TagBot adds it to the GitHub release later. +- Once the registration is completed, check that the TagBot correctly tagged the version and built a GitHub release. ### Releasing Breaking Changes