Thanks to visit codestin.com
Credit goes to github.com

Skip to content
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
62 changes: 54 additions & 8 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,65 @@ name: Release checklist
about: '[for maintainer use]'
title: 'Release 0.7.1'
labels: ''
assignees: 'joaander'

---

To make a new row release:

- [ ] Make a new `release-{X.Y.Z}` branch (where `{X.Y.Z}` is the new version).

On that branch, take the following steps (committing after each step when needed):

- [ ] Run `prek autoupdate`.
- [ ] Run *bump-my-version*.
- [ ] Run `cargo check`
- [ ] Run `cargo update`
- [ ] Run `cargo bundle-licenses --format yaml --output THIRDPARTY.yaml`
- [ ] Check for new or duplicate contributors since the last release:
`comm -13 (git log $(git describe --tags --abbrev=0) --format="%aN <%aE>" | sort | uniq | psub) (git log --format="%aN <%aE>" | sort | uniq | psub)`.
Add entries to `.mailmap` to remove duplicates.
- [ ] Review `release-notes.md` and revise if needed.
- [ ] Add highlights to release notes.
- [ ] Check readthedocs build, especially release notes formatting.
- [ ] Tag and push.
- [ ] Update conda-forge recipe.
- [ ] Run `cargo check`
- [ ] Run `cargo update`
- [ ] Run `cargo bundle-licenses --format yaml --output THIRDPARTY.yaml`
- [ ] Run `bump-my-version bump {type}`. Replace `{type}` with:
- `patch` when this release *only* includes bug fixes.
- `minor` when this release includes new features and possibly bug fixes.
- `major` when this release includes API breaking changes.
- [ ] Push the branch and open a pull request.
- [ ] Check that readthedocs builds the docs correctly in the pull request checks.
- [ ] Merge the pull request after all tests pass.
- [ ] Make a new tag on the main branch:
```
git switch main
git pull
git tag -a v{X.Y.Z}
git push origin --tags
```

> [!IMPORTANT]
> Make sure to include the `v` in the tag name!

- [ ] Add a blank release notes entry for the next release:
```
## Next release

*Added:*

*Changed:*

*Deprecated:*

*Removed:*

*Fixed:*
```

> [!NOTE]
> Paste `Next release` exactly as shown. `bump-my-version` will replace that
> string with the version number and date.

GitHub Actions will trigger on the tag and upload new wheels to crates.io and create a
GitHub release. After a few hours, the conda-forge autotick bot will submit a PR
for the new release.

- [ ] Check that the GitHub release posted correctly: https://github.com/glotzerlab/row/releases
- [ ] Check that the crates.io upload succeeded: https://crates.io/crates/row
- [ ] Merge the conda-forge recipe, updating it first if necessary (e.g. when adding dependencies).
2 changes: 2 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ jobs:
uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
- name: Set up mdbook
uses: glotzerlab/workflows/setup-mdbook@894d9678188a02b06560fdeb2b9ba98d016cd371 # 0.10.0
with:
mdbook_version: 0.5.0
- name: Build documentation
run: mdbook build doc
env:
Expand Down
4 changes: 4 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
Kate Jensen <[email protected]> kmjens <[email protected]>
Jen Bradley <[email protected]> Jen Bradley <[email protected]>
Jen Bradley <[email protected]> janbridley <[email protected]>
Joseph Burkhart <[email protected]> josephburkhart <[email protected]>
Joseph Burkhart <[email protected]> Joseph Burkhart <[email protected]>
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build:
- mkdir -p "${PATH%%:*}"
- curl -sSL "https://github.com/cargo-bins/cargo-binstall/releases/latest/download/cargo-binstall-x86_64-unknown-linux-gnu.tgz" | tar -xvz --directory "${PATH%%:*}"
# Install mdbook
- cargo binstall mdbook@0.4.52 [email protected].0 --no-confirm --install-path "${PATH%%:*}"
- cargo binstall mdbook@0.5.0 --no-confirm --install-path "${PATH%%:*}"
# Build the book
- mkdir -p $READTHEDOCS_OUTPUT/html
- echo "site-url = \"/$READTHEDOCS_LANGUAGE/$READTHEDOCS_VERSION/\"" >> doc/book.toml
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
![Row](row-horizontal.svg)

[![Crates.io Version](https://img.shields.io/crates/v/row?color=a44300)](https://crates.io/crates/row)
[![Read the Docs](https://img.shields.io/readthedocs/row/latest.svg)](https://row.readthedocs.io/)
[![GitHub Repository](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/glotzerlab/row)
[![GitHub Discussions](https://img.shields.io/github/discussions/glotzerlab/row)](https://github.com/glotzerlab/row/discussions/)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/glotzerlab/row?label=commits)](https://github.com/glotzerlab/row)
[![Contributors](https://img.shields.io/github/contributors-anon/glotzerlab/row.svg?style=flat)](https://row.readthedocs.io/en/latest/contributors.html)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-green.svg)](https://row.readthedocs.io/en/latest/license.html)
[![GitHub top language](https://img.shields.io/github/languages/top/glotzerlab/row?color=a44300)](https://rust-lang.org/)

Row is a command line tool that helps you manage workflows on HPC resources. Define
**actions** in a workflow configuration file that apply to **groups** of **directories**
Expand Down
5 changes: 0 additions & 5 deletions doc/book.toml
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
[book]
language = "en"
multilingual = false
src = "src"
title = "Row documentation"

[build]
create-missing = false

[preprocessor.alerts]

# [output.html] must be the last table so that .readthedocs.yaml can easily add a key to it
[output.html]
git-repository-url = "https://github.com/glotzerlab/row"
additional-css = ["rtd-mdbook.css", "theme/pagetoc.css" ]
additional-js = ["theme/pagetoc.js"]
edit-url-template = "https://github.com/glotzerlab/row/edit/trunk/doc/{path}"
24 changes: 0 additions & 24 deletions doc/rtd-mdbook.css

This file was deleted.

12 changes: 8 additions & 4 deletions doc/src/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@

*Added:*

* Rayon launcher that prefixes commands with `RAYON_NUM_THREADS={T}`.
* `slurm_gpus_per_task` cluster option.
* Rayon launcher that prefixes commands with `RAYON_NUM_THREADS={T}` (#195).
* `slurm_gpus_per_task` cluster option (#197).

*Changed:*

* Build the documentation with mdBook 0.5.0 (#203).

*Fixed:*

* Fix "JSON Pointers" example.
* Handle non-numeric suffixes written by `sbatch`.
* Fix "JSON Pointers" example (#191).
* Handle non-numeric suffixes written by `sbatch` (#197).

## 0.7.1 (2025-08-21)

Expand Down
Loading