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

Use placeholder for release versions before release #154

Closed
jl-wynen opened this issue Oct 2, 2023 · 2 comments · Fixed by #168
Closed

Use placeholder for release versions before release #154

jl-wynen opened this issue Oct 2, 2023 · 2 comments · Fixed by #168

Comments

@jl-wynen
Copy link
Collaborator

jl-wynen commented Oct 2, 2023

When adding directives like .. versionadded::, we need to provide a version number. But this is impossible to predict in CalVer.
So use a placeholder version. And implement a check in the release workflow to look for placeholders and stop if it finds any. Also add a script to replace placeholders. (This should not run automatically to reduce the risk of breaking the code.)

In Scipp, we use PLACEHOLDER or vPLACEHOLDER. Is this good enough or should we use a different placeholder text?

@YooSunYoung
Copy link
Collaborator

I just used RELEASE_PLACEHOLDER in #153

Cause it looked like prepare-release tox command uses this in scipp...?

[testenv:prepare-release]
description = Run before a release. Pass the release version as a positional argument.
skip_install = true
deps =
allowlist_externals = sh
commands =
  sh -c 'git grep -rl RELEASE_PLACEHOLDER docs/ src/scipp | xargs sed -i "s/RELEASE_PLACEHOLDER/{posargs}/g"'

@jl-wynen
Copy link
Collaborator Author

jl-wynen commented Oct 9, 2023

See also scipp/copier_template#35

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants