Skip to content

Commit

Permalink
Merge branch 'main' into mmg/rename-to-github-owner
Browse files Browse the repository at this point in the history
  • Loading branch information
paddyroddy authored Oct 23, 2024
2 parents 9e29dca + 60bbca6 commit 92fa293
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ jobs:
run: |-
git config user.name github-actions
git config user.email [email protected]
git tag --force ${{ env.TAG_NAME }} ${{ github.sha }}
git tag --force ${{ env.TAG_NAME }} ${{ github.ref_name }}
git push origin ${{ env.TAG_NAME }} --force
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ and how to use the newly created package with some of the tools included.
2. Run cookiecutter in the desired directory

```sh
cookiecutter gh:ucl-arc/python-tooling
cookiecutter gh:ucl-arc/python-tooling --checkout latest
```

If you have this repo locally (this may be the case if you are developing),
you can run the following:

```sh
cookiecutter /path/to/your/checkout/of/python-tooling
cookiecutter /path/to/your/checkout/of/python-tooling --checkout latest
```

3. A series of questions will pop up to configure the project. Type the answer
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ testpaths = [
[tool.ruff]
fix = true
force-exclude = true
target-version = "py39"
target-version = "py311"
lint.ignore = [
"COM812", # trailing commas (ruff-format recommended)
"D203", # no-blank-line-before-class
Expand Down
2 changes: 1 addition & 1 deletion tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ We will first go through the steps for creating a new package using the `UCL-ARC
4. To begin creating the package run

```sh
cookiecutter gh:ucl-arc/python-tooling
cookiecutter gh:ucl-arc/python-tooling --checkout latest
```

You will then be shown a series of prompts at the command line asking for details of the project and package. You can choose to use the default placeholder value (shown in parenthesis `()` in prompt) for any question by hitting `Enter`. If you already have a specific project in mind you want to set up a package for using the template you can use this project's details, otherwise you can just use the placeholder values. You should choose `Y` (yes) to the questions on whether to initialise Git repository and automatically deploy HTML documentation to GitHub Pages to allow you to complete the follow on exercises which rely on these options being enabled. For the prompt asking for the GitHub user or organization name to be owner of repository you should supply your GitHub user name.
Expand Down

0 comments on commit 92fa293

Please sign in to comment.