Skip to content

Commit d6d5c75

Browse files
author
bakebot
committed
Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool
- [#291](nautobot/cookiecutter-nautobot-app#291) - Added support for Python `3.13`. - [#291](nautobot/cookiecutter-nautobot-app#291) - Updated minimum Nautobot version to `3.0.0`. - [#291](nautobot/cookiecutter-nautobot-app#291) - Updated maximum Nautobot version to `<4.0.0`. - [#309](nautobot/cookiecutter-nautobot-app#309) - Change the tag-nautobot-app workflow to support multiple nautobot-app versions. - [#320](nautobot/cookiecutter-nautobot-app#320) - Upstream testing now runs against selected branches. - [#319](nautobot/cookiecutter-nautobot-app#319) - Fixed nav typo and added missing 2.7.2 release notes. - [#322](nautobot/cookiecutter-nautobot-app#322) - Updated CI workflow to always regenerate poetry lockfile. **Full Changelog**: nautobot/cookiecutter-nautobot-app@nautobot-app-v2.7.2...nautobot-app-v3.0.0
1 parent 96b2b2f commit d6d5c75

File tree

10 files changed

+102
-16
lines changed

10 files changed

+102
-16
lines changed

‎.cookiecutter.json‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,17 @@
1919
"_drift_manager": {
2020
"template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
2121
"template_dir": "nautobot-app",
22-
"template_ref": "nautobot-app-v2.7.1",
22+
"template_ref": "nautobot-app-v3.0.0",
2323
"cookie_dir": "",
24-
"branch_prefix": "drift-manager",
25-
"pull_request_strategy": "update-or-create",
24+
"pull_request_strategy": "create",
2625
"post_actions": [],
2726
"draft": false,
27+
<<<<<<< HEAD
2828
"baked_commit_ref": "a3ef45704aa84f29a06962419fe05333973b29cf"
29+
=======
30+
"baked_commit_ref": "693e930f422553503d3217ae7bf35cc94b353df1",
31+
"drift_managed_branch": "develop"
32+
>>>>>>> d85f8fe (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
2933
}
3034
}
3135
}

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ labels:
77

88
### Environment
99
* Python version: <!-- Example: 3.11.4 -->
10-
* Nautobot version: <!-- Example: 2.4.20 -->
10+
* Nautobot version: <!-- Example: 3.0.0 -->
1111
* nautobot-firewall-models version: <!-- Example: 1.0.0 -->
1212

1313
<!-- What did you expect to happen? -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels:
66
---
77

88
### Environment
9-
* Nautobot version: <!-- Example: 2.4.20 -->
9+
* Nautobot version: <!-- Example: 3.0.0 -->
1010
* nautobot-firewall-models version: <!-- Example: 1.0.0 -->
1111

1212
<!--

‎.github/workflows/ci.yml‎

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,71 @@ env:
1414
APP_NAME: "nautobot-firewall-models"
1515

1616
jobs:
17+
generate-lockfile:
18+
runs-on: "ubuntu-latest"
19+
steps:
20+
- name: "Check out repository code"
21+
uses: "actions/checkout@v4"
22+
- name: "Setup environment"
23+
uses: "networktocode/gh-action-setup-poetry-environment@v6"
24+
with:
25+
poetry-version: "2.1.3"
26+
poetry-install-options: "--only-root"
27+
- name: "Regenerate poetry.lock"
28+
run: "poetry lock --regenerate"
29+
- name: "Upload poetry.lock"
30+
uses: "actions/upload-artifact@v4"
31+
with:
32+
name: "poetry-lock"
33+
path: "poetry.lock"
1734
ruff-format:
35+
needs: "generate-lockfile"
1836
runs-on: "ubuntu-latest"
1937
env:
2038
INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
2139
steps:
2240
- name: "Check out repository code"
2341
uses: "actions/checkout@v4"
42+
- name: "Download poetry.lock artifact"
43+
uses: "actions/download-artifact@v4"
44+
with:
45+
name: "poetry-lock"
2446
- name: "Setup environment"
2547
uses: "networktocode/gh-action-setup-poetry-environment@v6"
2648
with:
2749
poetry-version: "2.1.3"
2850
- name: "Linting: ruff format"
2951
run: "poetry run invoke ruff --action format"
3052
ruff-lint:
53+
needs: "generate-lockfile"
3154
runs-on: "ubuntu-latest"
3255
env:
3356
INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
3457
steps:
3558
- name: "Check out repository code"
3659
uses: "actions/checkout@v4"
60+
- name: "Download poetry.lock artifact"
61+
uses: "actions/download-artifact@v4"
62+
with:
63+
name: "poetry-lock"
3764
- name: "Setup environment"
3865
uses: "networktocode/gh-action-setup-poetry-environment@v6"
3966
with:
4067
poetry-version: "2.1.3"
4168
- name: "Linting: ruff"
4269
run: "poetry run invoke ruff --action lint"
4370
check-docs-build:
71+
needs: "generate-lockfile"
4472
runs-on: "ubuntu-latest"
4573
env:
4674
INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
4775
steps:
4876
- name: "Check out repository code"
4977
uses: "actions/checkout@v4"
78+
- name: "Download poetry.lock artifact"
79+
uses: "actions/download-artifact@v4"
80+
with:
81+
name: "poetry-lock"
5082
- name: "Setup environment"
5183
uses: "networktocode/gh-action-setup-poetry-environment@v6"
5284
with:
@@ -68,25 +100,35 @@ jobs:
68100
- name: "Checking: poetry lock file"
69101
run: "poetry run invoke lock --check"
70102
yamllint:
103+
needs: "generate-lockfile"
71104
runs-on: "ubuntu-latest"
72105
env:
73106
INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
74107
steps:
75108
- name: "Check out repository code"
76109
uses: "actions/checkout@v4"
110+
- name: "Download poetry.lock artifact"
111+
uses: "actions/download-artifact@v4"
112+
with:
113+
name: "poetry-lock"
77114
- name: "Setup environment"
78115
uses: "networktocode/gh-action-setup-poetry-environment@v6"
79116
with:
80117
poetry-version: "2.1.3"
81118
- name: "Linting: yamllint"
82119
run: "poetry run invoke yamllint"
83120
markdownlint:
121+
needs: "generate-lockfile"
84122
runs-on: "ubuntu-latest"
85123
env:
86124
INVOKE_NAUTOBOT_FIREWALL_MODELS_LOCAL: "True"
87125
steps:
88126
- name: "Check out repository code"
89127
uses: "actions/checkout@v4"
128+
- name: "Download poetry.lock artifact"
129+
uses: "actions/download-artifact@v4"
130+
with:
131+
name: "poetry-lock"
90132
- name: "Setup environment"
91133
uses: "networktocode/gh-action-setup-poetry-environment@v6"
92134
with:
@@ -104,7 +146,11 @@ jobs:
104146
strategy:
105147
fail-fast: true
106148
matrix:
149+
<<<<<<< HEAD
107150
python-version: ["3.11"]
151+
=======
152+
python-version: ["3.10"]
153+
>>>>>>> d85f8fe (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
108154
nautobot-version: ["3.0.0"]
109155
env:
110156
INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}"
@@ -154,12 +200,18 @@ jobs:
154200
db-backend: ["postgresql"]
155201
nautobot-version: ["stable"]
156202
include:
157-
- python-version: "3.11"
203+
- python-version: "3.10"
158204
db-backend: "postgresql"
159205
nautobot-version: "3.0.0"
206+
<<<<<<< HEAD
160207
# - python-version: "3.12"
161208
# db-backend: "mysql"
162209
# nautobot-version: "stable"
210+
=======
211+
- python-version: "3.13"
212+
db-backend: "mysql"
213+
nautobot-version: "stable"
214+
>>>>>>> d85f8fe (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
163215
runs-on: "ubuntu-latest"
164216
env:
165217
INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}"
@@ -198,7 +250,6 @@ jobs:
198250
if: "matrix.db-backend == 'mysql'"
199251
- name: "Run Tests"
200252
run: "poetry run invoke unittest"
201-
202253
unittest_report:
203254
needs:
204255
- "check-in-docker"
@@ -271,8 +322,8 @@ jobs:
271322
with:
272323
name: "python-coverage-comment-action"
273324
path: "python-coverage-comment-action.txt"
274-
275325
changelog:
326+
needs: "generate-lockfile"
276327
if: >
277328
contains(fromJson('["develop","ltm-1.6"]'), github.base_ref) &&
278329
(github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
@@ -282,6 +333,10 @@ jobs:
282333
uses: "actions/checkout@v4"
283334
with:
284335
fetch-depth: "0"
336+
- name: "Download poetry.lock artifact"
337+
uses: "actions/download-artifact@v4"
338+
with:
339+
name: "poetry-lock"
285340
- name: "Setup environment"
286341
uses: "networktocode/gh-action-setup-poetry-environment@v6"
287342
with:

‎.github/workflows/upstream_testing.yml‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,26 @@ name: "Nautobot Upstream Monitor"
33

44
on: # yamllint disable-line rule:truthy rule:comments
55
schedule:
6-
- cron: "0 4 */2 * *" # every other day at midnight
6+
- cron: "0 4 */2 * *" # every other day at 4 AM
77
workflow_dispatch:
88

99
jobs:
1010
upstream-test:
11+
strategy:
12+
fail-fast: false
13+
matrix:
14+
include:
15+
- nautobot_branch: "develop"
16+
app_branch: "main"
17+
- nautobot_branch: "next"
18+
app_branch: "main"
19+
- nautobot_branch: "ltm-2.4"
20+
app_branch: "ltm-2.4"
21+
# - nautobot_branch: "next-4.0"
22+
# app_branch: "next-4.0"
1123
uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
1224
with: # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
1325
invoke_context_name: "NAUTOBOT_FIREWALL_MODELS"
14-
plugin_name: "nautobot-firewall-models"
26+
app_name: "nautobot-firewall-models"
27+
nautobot_branch: "${{ matrix.nautobot_branch }}"
28+
app_branch: "${{ matrix.app_branch }}"

‎changes/+nautobot-app-v3.0.0.housekeeping‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Rebaked from the cookie `nautobot-app-v3.0.0`.

‎docs/admin/compatibility_matrix.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Compatibility Matrix
22

3+
<<<<<<< HEAD
34
| Nautobot App Firewall Model Version | Nautobot First Support Version | Nautobot Last Support Version |
45
| ----------------------------------- | ------------------------------ | ----------------------------- |
56
| 1.0.X | 1.2.0 | 1.5.99 |
@@ -11,3 +12,11 @@
1112
| 2.3.X | 2.4.2 | 2.99.99 |
1213
| 2.4.X | 2.4.20 | 2.99.99 |
1314
| 3.0.X | 3.0.0 | 3.99.99 |
15+
=======
16+
!!! warning "Developer Note - Remove Me!"
17+
Explain how the release models of the app and of Nautobot work together, how releases are supported, how features and older releases are deprecated etc.
18+
19+
| Nautobot Firewall Models Version | Nautobot First Support Version | Nautobot Last Support Version |
20+
| ------------- | -------------------- | ------------- |
21+
| 1.0.X | 3.0.0 | 2.99.99 |
22+
>>>>>>> d85f8fe (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)

‎docs/admin/install.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Here you will find detailed instructions on how to **install** and **configure**
44

55
## Prerequisites
66

7-
- The app is compatible with Nautobot 2.4.20 and higher.
7+
- The app is compatible with Nautobot 3.0.0 and higher.
88
- Databases supported: PostgreSQL, MySQL
99

1010
!!! note

‎docs/dev/dev_environment.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is a quick reference guide if you're already familiar with the development
1313

1414
The [Invoke](http://www.pyinvoke.org/) library is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to Invoke to override the default configuration:
1515

16-
- `nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: 2.4.20)
16+
- `nautobot_ver`: the version of Nautobot to use as a base for any built docker containers (default: 3.0.0)
1717
- `project_name`: the default docker compose project name (default: `nautobot-firewall-models`)
1818
- `python_ver`: the version of Python to use as a base for any built docker containers (default: 3.12)
1919
- `local`: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)
@@ -181,7 +181,7 @@ The first thing you need to do is build the necessary Docker image for Nautobot
181181
#14 exporting layers
182182
#14 exporting layers 1.2s done
183183
#14 writing image sha256:2d524bc1665327faa0d34001b0a9d2ccf450612bf8feeb969312e96a2d3e3503 done
184-
#14 naming to docker.io/nautobot-firewall-models/nautobot:2.4.20-py3.12 done
184+
#14 naming to docker.io/nautobot-firewall-models/nautobot:3.0.0-py3.12 done
185185
```
186186

187187
### Invoke - Starting the Development Environment
@@ -212,9 +212,9 @@ This will start all of the Docker containers used for hosting Nautobot. You shou
212212
```bash
213213
➜ docker ps
214214
****CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
215-
ee90fbfabd77 nautobot-firewall-models/nautobot:2.4.20-py3.12 "nautobot-server rqw…" 16 seconds ago Up 13 seconds nautobot_firewall_models_worker_1
216-
b8adb781d013 nautobot-firewall-models/nautobot:2.4.20-py3.12 "/docker-entrypoint.…" 20 seconds ago Up 15 seconds 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp nautobot_firewall_models_nautobot_1
217-
d64ebd60675d nautobot-firewall-models/nautobot:2.4.20-py3.12 "mkdocs serve -v -a …" 25 seconds ago Up 18 seconds 0.0.0.0:8001->8080/tcp, :::8001->8080/tcp nautobot_firewall_models_docs_1
215+
ee90fbfabd77 nautobot-firewall-models/nautobot:3.0.0-py3.12 "nautobot-server rqw…" 16 seconds ago Up 13 seconds nautobot_firewall_models_worker_1
216+
b8adb781d013 nautobot-firewall-models/nautobot:3.0.0-py3.12 "/docker-entrypoint.…" 20 seconds ago Up 15 seconds 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp nautobot_firewall_models_nautobot_1
217+
d64ebd60675d nautobot-firewall-models/nautobot:3.0.0-py3.12 "mkdocs serve -v -a …" 25 seconds ago Up 18 seconds 0.0.0.0:8001->8080/tcp, :::8001->8080/tcp nautobot_firewall_models_docs_1
218218
e72d63129b36 postgres:13-alpine "docker-entrypoint.s…" 25 seconds ago Up 19 seconds 0.0.0.0:5432->5432/tcp, :::5432->5432/tcp nautobot_firewall_models_postgres_1
219219
96c6ff66997c redis:6-alpine "docker-entrypoint.s…" 25 seconds ago Up 21 seconds 0.0.0.0:6379->6379/tcp, :::6379->6379/tcp nautobot_firewall_models_redis_1
220220
```

‎pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ include = [
3030
python = ">=3.10,<3.14"
3131
# Used for local development
3232
nautobot = ">=3.0.0,<4.0.0"
33+
<<<<<<< HEAD
3334
capirca = "^2.0.6"
35+
=======
36+
>>>>>>> d85f8fe (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
3437

3538
[tool.poetry.group.dev.dependencies]
3639
coverage = "*"

0 commit comments

Comments
 (0)