~adigitoleo/PlateMotionRequests.jl

e80d751cf4cd1f87239df1118545ef28f43dfc0f — adigitoleo 6 months ago e002c03
release: Prepare release v3.1.1
2 files changed, 15 insertions(+), 8 deletions(-)

M CONTRIBUTING.md
M docs/src/changelog.md
M CONTRIBUTING.md => CONTRIBUTING.md +7 -7
@@ 87,11 87,11 @@ which is used for hosting the documentation.
### Preparing the release on `next`

1. Update the project manifest: `julia --project=$PWD -e 'using Pkg; Pkg.update()'`.
2. Verify that any tests are passing locally (or debug failures/errors, separate commits).
3. Update the documentation files, including `docs/make.jl` if necessary.
4. Update `docs/src/changelog.md` with an `Unreleased <date>` section (concise list of changes).
5. If the changelog is larger than 1MB, split off a `changelog-<version_range>.md` for old versions.
6. Run [JuliaFormatter](https://github.com/domluna/JuliaFormatter.jl) on the entire `src/` tree.
2. Run [JuliaFormatter](https://github.com/domluna/JuliaFormatter.jl) on the entire `src/` tree.
3. Verify that any tests are passing locally (or debug failures/errors, separate commits).
4. Update the documentation files, including `docs/make.jl` (although it can't be tested until the new version is registered).
5. Update `docs/src/changelog.md` with an `Unreleased` section (concise list of changes).
6. If the changelog is larger than 1MB, split off a `changelog-<version_range>.md` for old versions.
7. Commit the changes to `next` with a message like `Prepare release v<version>`.
8. **Don't add a tag!** Releases must only be tagged after registration on `main`.
9. Push `next` to all remotes.


@@ 103,11 103,11 @@ Then the HTML documentation also needs to be built, and the package can be regis
[Registrator.jl](https://github.com/JuliaRegistries/Registrator.jl).
After merging, switch to `main`, then:

1. Bump the version number in `Project.toml` and register the package.
1. Bump the version number in `Project.toml`, rename the `Unreleased` changelog section and register the package.
2. Resolve issues raised by registry maintainers and repeat step 1 **with new patch versions**.
3. After successful registration, create an annotated git tag with `git tag -am "Version <version>" v<version>`.
4. Create a documentation branch with `git switch -c gh-pages-<version>`.
5. Build the web docs **on the new branch** with `julia --project=docs/ docs/make.jl`.
5. Build the web docs **on the new branch** with `julia --project=docs/ docs/make.jl` (commit any fixes on this branch also).
6. From the project root: `mv docs/build site`.
7. Remove the `docs` folder **only on this branch** (due to GitHub Pages inflexibility).
8. From the project root: `mv site docs`, `git add -A`, `git c -m "Docs for v<version>"`.

M docs/src/changelog.md => docs/src/changelog.md +8 -1
@@ 5,12 5,19 @@ Notable changes to this project are documented here.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

The first version of this package registered in the [Julia General registry](https://github.com/JuliaRegistries/General) was v3.1.0, earlier versions should be considered experimental.

## [Unreleased]

## Changed
- test suite, to avoid running NetCDF tests on Windows (currently broken)

## [3.1.0] : 2022-05-23

### Added
- NetCDF output tests
- `WriteError` for error semantics when trying to write irregular data to NetCDF (unsupported)
- Support for reading right-aligned tabular data files with `read_platemotion`
- support for reading right-aligned tabular data files with `read_platemotion`

## [3.0.0] : 2022-01-18