From c9d86d00c08390dfa2bbb1e9e1e878321a3b6fa6 Mon Sep 17 00:00:00 2001 From: Peter Boulos Date: Mon, 2 Sep 2024 02:29:23 -0400 Subject: [PATCH] Bugfixes for EOF, whitespace, and prettier checks. (#120) --- .../.devcontainer/devcontainer.json | 5 +---- .../.github/actions/setup-poetry-env/action.yml | 8 ++++---- .../.github/workflows/main.yml | 1 - .../.github/workflows/on-release-main.yml | 8 ++++---- {{cookiecutter.project_name}}/README.md | 16 ++++++---------- {{cookiecutter.project_name}}/mkdocs.yml | 6 +++--- 6 files changed, 18 insertions(+), 26 deletions(-) diff --git a/{{cookiecutter.project_name}}/.devcontainer/devcontainer.json b/{{cookiecutter.project_name}}/.devcontainer/devcontainer.json index c83a2b3..d4b676d 100644 --- a/{{cookiecutter.project_name}}/.devcontainer/devcontainer.json +++ b/{{cookiecutter.project_name}}/.devcontainer/devcontainer.json @@ -14,10 +14,7 @@ // Configure tool-specific properties. "customizations": { "vscode": { - "extensions": [ - "ms-python.python", - "editorconfig.editorconfig", - ], + "extensions": ["ms-python.python", "editorconfig.editorconfig"], "settings": { "python.testing.pytestArgs": ["tests"], "python.testing.unittestEnabled": false, diff --git a/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml b/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml index 4e5f9fd..8ed6bcc 100644 --- a/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml +++ b/{{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml @@ -2,10 +2,10 @@ name: "setup-poetry-env" description: "Composite action to setup the Python and poetry environment." inputs: - python-version: - required: false - description: "The python version to use" - default: "3.11" + python-version: + required: false + description: "The python version to use" + default: "3.11" runs: using: "composite" diff --git a/{{cookiecutter.project_name}}/.github/workflows/main.yml b/{{cookiecutter.project_name}}/.github/workflows/main.yml index 329ec83..5dd2e55 100644 --- a/{{cookiecutter.project_name}}/.github/workflows/main.yml +++ b/{{cookiecutter.project_name}}/.github/workflows/main.yml @@ -48,7 +48,6 @@ jobs: - name: Check typing run: poetry run mypy - {% if cookiecutter.codecov == "y" %} - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11 uses: codecov/codecov-action@v4 diff --git a/{{cookiecutter.project_name}}/.github/workflows/on-release-main.yml b/{{cookiecutter.project_name}}/.github/workflows/on-release-main.yml index b880900..fb19096 100644 --- a/{{cookiecutter.project_name}}/.github/workflows/on-release-main.yml +++ b/{{cookiecutter.project_name}}/.github/workflows/on-release-main.yml @@ -6,7 +6,7 @@ on: branches: [main] jobs: - {% if cookiecutter.publish_to != "none" %} +{%- if cookiecutter.publish_to != "none" %} publish: runs-on: ubuntu-latest steps: @@ -39,8 +39,8 @@ jobs: RELEASE_VERSION: ${{ steps.vars.outputs.tag }} {%- endraw -%} {%- endif %} - {% endif %} - {%- if cookiecutter.mkdocs == "y" %} +{%- endif -%} +{%- if cookiecutter.mkdocs == "y" %} deploy-docs: {%- if cookiecutter.publish_to != "none" %} needs: publish @@ -55,4 +55,4 @@ jobs: - name: Deploy documentation run: poetry run mkdocs gh-deploy --force - {% endif %} +{% endif %} diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index baabcb4..6f12a7e 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -35,26 +35,22 @@ The CI/CD pipeline will be triggered when you open a pull request, merge to main To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github). To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/). - +{% if cookiecutter.publish_to == "pypi" %} ## Releasing a new version -{% if cookiecutter.publish_to == "pypi" -%} - - Create an API Token on [Pypi](https://pypi.org/). - Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/settings/secrets/actions/new). - Create a [new release](https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/releases/new) on Github. - Create a new tag in the form `*.*.*`. - -For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release). -{%- elif cookiecutter.publish_to == "artifactory" -%} +- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release). +{% elif cookiecutter.publish_to == "artifactory" %} +## Releasing a new version - Add the `ARTIFACTORY_URL`, `ARTIFACTORY_USERNAME`, and `ARTIFACTORY_PASSWORD` to your projects secrets by visiting [this page](https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/settings/secrets/actions/new). - Create a [new release](https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/releases/new) on Github. - Create a new tag in the form `*.*.*`. - -For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release). -{%- endif %} - +- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release). +{% endif %} --- Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry). diff --git a/{{cookiecutter.project_name}}/mkdocs.yml b/{{cookiecutter.project_name}}/mkdocs.yml index e5a65b0..69ba4aa 100644 --- a/{{cookiecutter.project_name}}/mkdocs.yml +++ b/{{cookiecutter.project_name}}/mkdocs.yml @@ -15,9 +15,9 @@ plugins: - mkdocstrings: handlers: python: - setup_commands: - - import sys - - sys.path.append('../') + setup_commands: + - import sys + - sys.path.append('../') theme: name: material feature: