Skip to content

Commit

Permalink
Update notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pronovic committed Oct 23, 2022
1 parent a524424 commit 219f811
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .run/commands/tagrelease.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ command_tagrelease() {
VERSION=$(echo "$1" | sed 's/^v//') # so you can use "0.1.5 or "v0.1.5"
EARLIEST_YEAR=$(git log --pretty="%ci" $(git rev-list --max-parents=0 HEAD) | sed 's/-.*$//g')
LATEST_YEAR=$(git log -1 --pretty="%ci" | sed 's/-.*$//g')
DEFAULT_BRANCH=$(git config --get init.defaultBranch)
DEFAULT_BRANCH=$(git config --get init.defaultBranch) # works on git > 2.28.0 from 2020
CURRENT_BRANCH=$(git branch -a | grep '^\*' | sed 's/^\* //')
COPYRIGHT="${EARLIEST_YEAR}-${LATEST_YEAR}"
DATE=$(date +'%d %b %Y')
Expand Down
24 changes: 18 additions & 6 deletions .run/tasks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,32 @@ implement that behavior within the task itself rather than breaking it up
between a task and a command. This helps make it more obvious that your new
task is repository-specific.

## Basic Tasks
## Required Tasks

The following basic tasks must always be defined if you want to use the
standard `run` script:
The following tasks must always be defined if you want to use the standard
`run` script:

- install
- format
- checks
- test
- suite

These tasks are called out separately in the help output for the `run` script.
All other tasks are listed in alphabetical order in a separate section below.
You can change the definition of these tasks, but they must exist.
These tasks are needed to set up the local development environment, and the
GitHub Actions build also relies on them. They are called out separately as
"basic tasks" in the help output for the `run` script. All other tasks are
listed in alphabetical order in a separate section below. You can change the
definition of these tasks, but they must exist.

Additionally, there are two "hidden" tasks that are not shown in the help
output for the `run` script:

- mypy
- pylint

These tasks exist for easy integration with Pycharm. If you don't want to use
one of these tools, just change the task to a no-op (i.e. `echo "MyPy is not
used in this repo"`).

## Creating a new task

Expand Down

0 comments on commit 219f811

Please sign in to comment.