Skip to content

Commit 43b67a4

Browse files
authored
added news link (#620)
* added news link * moved or * fixed format * added note about docs branches to pr template
1 parent 2ae4053 commit 43b67a4

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
When opening your PR, please make sure to only request a merge to `main` when you have found a bug in the currently released version of TransformerLens. All other PRs should go to `dev` in order to keep the docs in sync with the currently released version.
33
44
Please also make sure the branch you are attempting to merge from is not named `main`, or `dev`. Branches with these names from a different remote cause conflicting name issues when we periodically attempt to bring your PR up to date with the current stable TransformerLens source.
5+
6+
If your PR is primarily affecting docs, make sure has the string "docs" in its name. Building docs is disabled by default to avoid CI time, but the job has been configured to run whenever a branch with the word "docs" in it is being merged.
57
-->
68
# Description
79

.github/workflows/checks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ jobs:
166166
# When running on merge to main, it builds the docs and then another job deploys them
167167
name: 'Build Docs'
168168
runs-on: ubuntu-latest
169-
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev')
169+
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') || contains(github.head_ref, 'docs')
170170
needs: code-checks
171171
steps:
172172
- uses: actions/checkout@v4

docs/source/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ generated/demos/Exploratory_Analysis_Demo
4747
content/special_cases
4848
```
4949

50+
```{toctree}
51+
:hidden:
52+
:caption: News
53+
54+
content/news/release-2.0
55+
```
56+
5057
```{toctree}
5158
:hidden:
5259
:caption: Development

0 commit comments

Comments
 (0)