feat(release-please): release-please as a new option for release automation (WIP)

src/scicookie/cookiecutter.json

@@ -42,6 +42,7 @@
   ],
   "governance_document": ["None", "numpy-governance", "sciml-governance"],
   "roadmap_document": ["None", "pytorch-ignite-roadmap"],
+  "release_workflow": ["semantic-release", "release-please", "None"],
   "build_system": [
     "poetry",
     "flit",

src/scicookie/hooks/post_gen_project.py

@@ -95,6 +95,19 @@
 BUILD_SYSTEM = None
 {%- endif %}
 
+ALL_RELEASE_DIRS = [
+    PROJECT_DIRECTORY / 'release-semantic',
+    PROJECT_DIRECTORY / 'release-please',
+]
+
+{% if cookiecutter.release_workflow == "semantic-release" -%}
+RELEASE_PATH = PROJECT_DIRECTORY / '.github' / 'workflows' / 'release.yaml'
+{% if cookiecutter.release_workflow == "release-please" -%}
+RELEASE_PATH = PROJECT_DIRECTORY / '.github' / 'workflows' / 'release-please.yaml'
+{% else %}
+RELEASE_PATH = None
+{%- endif %}
+
 
 def remove_dirs(dirs: list):
     for dirs in dirs:

src/scicookie/profiles/base.yaml

@@ -262,6 +262,18 @@ roadmap_document:
     - pytorch-ignite-roadmap
   visible: true
 
+release_workflow:
+  message: Select one option for release automation tool for this project
+  help: "For more information, check:\n  https://osl-incubator.github.io/scicookie/guide/#release-workflow"
+  type: single-choice
+  default: None
+  # first choice is the default for the UI
+  choices:
+    - None
+    - semantic-release
+    - release-please
+  visible: true
+
 git_username:
   message: Type the GIT username
   help: https://osl-incubator.github.io/scicookie/guide/#control-version

src/scicookie/profiles/osl.yaml

@@ -91,6 +91,10 @@ roadmap_document:
   default: None
   visible: false
 
+release_workflow:
+  default: semantic-release
+  visible: false
+
 git_username:
   default: yorbriar
   visible: true

src/scicookie/{{cookiecutter.project_slug}}/.makim.yaml

@@ -121,6 +121,7 @@ groups:
     vars:
       app: |
         npx --yes \
+        {%- if cookiecutter.release_workflow == "semantic-release" %}
         -p semantic-release \
         -p "@semantic-release/commit-analyzer" \
         -p "@semantic-release/release-notes-generator" \
@@ -130,12 +131,29 @@ groups:
         -p "@semantic-release/git" \
         -p "@google/semantic-release-replace-plugin" \
         semantic-release
+        {%- if cookiecutter.release_workflow == "release-please" %}
+        -p release-please \
+        -p release-please release-pr 
+          --token=$GITHUB_TOKEN \
+          --repo-url={{ cookiecutter.git_username }}/{{ cookiecutter.git_main_branch }} --config-file
+        release-please github-release \
+          --token=$GITHUB_TOKEN
+          --repo-url={{ cookiecutter.git_username }}/{{ cookiecutter.git_main_branch }} --config-file
+        release-please
 
     tasks:
       ci:
+        {%- if cookiecutter.release_workflow == "semantic-release" %}
         help: run semantic release on CI
         run: {{ "${{ vars.app }} --ci" }}
+        {%- if cookiecutter.release_workflow == "release-please" %}
+        help: run release please on CI
+        run: {{ "${{ vars.app }}" }}
 
       dry:
+        {%- if cookiecutter.release_workflow == "semantic-release" %}
         help: run semantic release in dry-run mode
         run: {{ "${{ vars.app }} --dry-run" }}
+        {%- if cookiecutter.release_workflow == "release-please" %}
+        help: run release please in dry-run mode
+        run: {{ "${{ vars.app }} --dry-run" }}

src/scicookie/{{cookiecutter.project_slug}}/build-system/mesonpy/meson.build

@@ -4,13 +4,24 @@
 {% set package_path = cookiecutter.package_slug -%}
 {% endif -%}
 {% set cpp_path = "src" -%}
+{% if cookiecutter.release_workflow == "semantic-release -%}
 project(
   '{{ cookiecutter.project_slug }}',
   'cpp',
   version: '{{ cookiecutter.project_version }}',  # semantic-release
   license: '{{ cookiecutter.project_license }}',
   meson_version: '>= 1.1.0',
 )
+{% endif -%}
+{% if cookiecutter.release_workflow == "release-please -%}
+project(
+  '{{ cookiecutter.project_slug }}',
+  'cpp',
+  version: '{{ cookiecutter.project_version }}',  # release-please
+  license: '{{ cookiecutter.project_license }}',
+  meson_version: '>= 1.1.0',
+)
+{% endif -%}
 name = '{{ cookiecutter.package_slug }}'
 
 cpp_sources = files('src/main.cpp')

src/scicookie/{{cookiecutter.project_slug}}/build-system/poetry/pyproject.toml

@@ -6,7 +6,12 @@
 
 [tool.poetry]
 name = "{{ cookiecutter.project_slug }}"
+{% if cookiecutter.release_workflow == "semantic-release" -%}
 version = "{{ cookiecutter.project_version }}"  # semantic-release
+{% endif -%}
+{% if cookiecutter.release_workflow == "release-please" -%}
+version = "{{ cookiecutter.project_version }}"  # release-please
+{% endif -%}
 description = "{{ cookiecutter.project_short_description }}"
 readme = "README.md"
 authors = ["{{ cookiecutter.author_full_name }} <{{ cookiecutter.author_email }}>"]

src/scicookie/{{cookiecutter.project_slug}}/release-please/release-please.yml

@@ -0,0 +1,30 @@
+name: release-please
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+        # this assumes that you have created a personal access token
+        # (PAT) and configured it as a GitHub action secret named
+        # `MY_RELEASE_PLEASE_TOKEN`.
+        token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+        config-file: release-please-config.json

src/scicookie/{{cookiecutter.project_slug}}/virtualenvs/conda/dev.yaml

@@ -28,7 +28,7 @@ dependencies:
   - pybind11
   - cmake
 {%- endif %}
-  - nodejs # used by semantic-release
+  - nodejs # used by semantic-release and release-please
 {%- if cookiecutter.use_shellcheck == "yes" %}
   - shellcheck
 {%- endif %}

src/scicookie/{{cookiecutter.project_slug}}/virtualenvs/pyenv/requirements.txt

@@ -22,7 +22,7 @@ cmake
 pybind11
 cmake
 {%- endif %}
-nodejs  # used by semantic-release
+nodejs  # used by semantic-release and release-please
 {%- if cookiecutter.use_shellcheck == "yes" %}
 shellcheck
 {%- endif %}

src/scicookie/{{cookiecutter.project_slug}}/{{cookiecutter.package_slug}}/__init__.py

@@ -15,7 +15,12 @@ def get_version() -> str:
     try:
         return importlib_metadata.version(__name__)
     except importlib_metadata.PackageNotFoundError:  # pragma: no cover
+        {%- if cookiecutter.release_worlflow == "semantic-release" %}
         return {{ QUOTE }}{{ cookiecutter.project_version }}{{ QUOTE }}  # semantic-release
+        {%- endif %}
+        {%- if cookiecutter.release_worlflow == "release-please" %}
+        return {{ QUOTE }}{{ cookiecutter.project_version }}{{ QUOTE }}  # release-please
+        {%- endif %}
 
 
 version = get_version()