Skip to content

Feature/release scripts#14

Open
RK206 wants to merge 2 commits into
masterfrom
feature/release_scripts
Open

Feature/release scripts#14
RK206 wants to merge 2 commits into
masterfrom
feature/release_scripts

Conversation

@RK206

@RK206 RK206 commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

These scripts are useful to make releases

@RK206
RK206 requested a review from Steven-Eardley July 7, 2026 07:16

@Steven-Eardley Steven-Eardley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think out of these, the static pages one is what I'd be most likely to use. I do have concerns about the edge cases you'll encounter when doing pulls and pushes so I worry about them being done in a script, in case they require user input.

There's also a lot of code duplication involved across these scripts - the steps could be factored out to shared functions and called from the individual scripts. That might make it look a lot more complicated, however.

A couple of comments added, but the only change it needs is to be less opinionated about when a version bump occurs. JS changes isn't the only time.

fi

if confirm "git pull (develop)"; then
git pull

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might only work if there are only fast-forward merges (i.e. non-interactive) on pull.


# Create release branch
if confirm "git flow release start $RELEASE_NAME"; then
git flow release start $RELEASE_NAME

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth documenting that git flow (and git flow setup / config) are dependencies.

echo "You need to update the version in setup.py and portality/settings.py"

if confirm "Edit setup.py to update DOAJ_VERSION"; then
${EDITOR:-vi} setup.py

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I presume this is the environment variable to use to get the user's default editor?

git commit -m "Update DOAJ_VERSION for release"
fi
else
echo "No JS/CSS changes detected. Version update not required."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also update the version for other reasons e.g. for the changelog, and for model changes. Apart from static pages, I don't do many releases without bumping the version. It also serves to tell the servers that the package is updated.

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 this pull request may close these issues.

2 participants