Skip to content

Commit

Permalink
Update notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonas1312 committed Oct 27, 2023
1 parent 85f0f66 commit 2cca005
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 15 deletions.
3 changes: 2 additions & 1 deletion .github/scripts/update_readme_tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ def dir_path_to_str(path: Path, linkify: bool) -> str:
markdown_file_str = markdown_files[0].read_text(encoding="utf-8")
# Check if all the filenames are in the markdown file.
if all(
(filename in markdown_file_str) or (urllib.parse.quote(filename) in markdown_file_str) # type: ignore
(filename in markdown_file_str)
or (urllib.parse.quote(filename) in markdown_file_str) # type: ignore
for filename in filenames
):
return f"[{path.name}](<{markdown_files[0].as_posix()}>)"
Expand Down
25 changes: 11 additions & 14 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,30 +1,27 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
rev: v4.5.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
- id: detect-private-key

- repo: https://github.com/psf/black
rev: 23.3.0
hooks:
- id: black

- repo: https://github.com/pycqa/isort
rev: 5.12.0
hooks:
- id: isort
name: isort (python)

- repo: https://github.com/adamchainz/blacken-docs
rev: "1.14.0"
rev: "1.16.0"
hooks:
- id: blacken-docs
additional_dependencies:
- black==23.3.0

- repo: https://github.com/rhysd/actionlint
rev: v1.6.25
rev: v1.6.26
hooks:
- id: actionlint

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.3
hooks:
- id: ruff
types_or: [python, pyi, jupyter]
- id: ruff-format
types_or: [python, pyi, jupyter]
11 changes: 11 additions & 0 deletions base/science-tech-maths/programming/dev-tools/github/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Add .patch or .diff after url:
- <https://github.com/pytorch/pytorch/pull/20853.diff>
- <https://github.com/pytorch/pytorch/pull/20853.patch>

## Release

Configuring automatically generated release notes: <https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes>

## GitHub Actions

### Matrix for multistage deployment
Expand Down Expand Up @@ -110,6 +114,12 @@ jobs:
...
```

```yaml
concurrency:
group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
cancel-in-progress: true
```

### Check if on tag

```yaml
Expand All @@ -122,6 +132,7 @@ if: startsWith(github.ref, 'refs/tags/')
- <https://marketplace.visualstudio.com/items?itemName=cschleiden.vscode-github-actions>
- <https://github-actions-hero.vercel.app/>
- <https://github.com/rhysd/actionlint>
- <https://github.com/tj-actions/changed-files>

## GitHub README Profile

Expand Down

0 comments on commit 2cca005

Please sign in to comment.