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/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: semantic-release
+  # first choice is the default for the UI
+  choices:
+    - semantic-release
+    - release-please
+    - None
+  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}}/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}}/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()