Merge pull request netbox-community#16429 from netbox-community/develop

Release v4.0.5

Author: jeremystretch

.github/workflows/auto-assign-issue.yml

@@ -12,10 +12,10 @@ jobs:
   auto-assign:
     runs-on: ubuntu-latest
     steps:
-      - uses: pozil/auto-assign-issue@v1
+      - uses: pozil/auto-assign-issue@v2
         if: "contains(github.event.issue.labels.*.name, 'status: needs triage')"
         with:
           # Weighted assignments
-          assignees: arthanson:3, jeffgdotorg:3, jeremystretch:3, abhi1693, DanSheps
+          assignees: arthanson:3, jeffgdotorg:3, jeremystretch:3, DanSheps
           numOfAssignee: 1
           abortIfPreviousAssignees: true

.github/workflows/ci.yml

@@ -1,7 +1,18 @@
 name: CI
-on: [push, pull_request]
+
+on:
+  push:
+    paths-ignore:
+      - 'contrib/**'
+      - 'docs/**'
+  pull_request:
+    paths-ignore:
+      - 'contrib/**'
+      - 'docs/**'
+
 permissions:
   contents: read
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -34,20 +45,20 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
 
     - name: Install Yarn Package Manager
       run: npm install -g yarn
 
     - name: Setup Node.js with Yarn Caching
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: yarn

.github/workflows/close-stale-issues.yml

@@ -29,7 +29,7 @@ jobs:
             necessary.
           days-before-issue-stale: 90
           days-before-issue-close: 30
-          exempt-issue-labels: 'status: accepted,status: blocked,status: needs milestone'
+          exempt-issue-labels: 'status: accepted,status: backlog,status: blocked'
           stale-issue-label: 'pending closure'
           stale-issue-message: >
             This issue has been automatically marked as stale because it has not had

.github/workflows/update-translation-strings.yml

@@ -0,0 +1,45 @@
+name: Update translation strings
+
+on:
+  schedule:
+    - cron: '0 5 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+env:
+  LOCALE: "en"
+
+jobs:
+  makemessages:
+    runs-on: ubuntu-latest
+    env:
+      NETBOX_CONFIGURATION: netbox.configuration_testing
+
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install system dependencies
+      run: sudo apt install -y gettext
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Run makemessages
+      run: python netbox/manage.py makemessages -l ${{ env.LOCALE }}
+
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v9
+      with:
+        add: 'netbox/translations/'
+        default_author: github_actions
+        message: 'Update source translation strings'

.gitignore

@@ -21,6 +21,7 @@ local_settings.py
 !upgrade.sh
 fabfile.py
 gunicorn.py
+uwsgi.ini
 netbox.log
 netbox.pid
 .DS_Store

docs/customization/custom-scripts.md

@@ -65,12 +65,6 @@ class AnotherCustomScript(Script):
 script_order = (MyCustomScript, AnotherCustomScript)
 ```
 
-## Module Attributes
-
-### `name`
-
-You can define `name` within a script module (the Python file which contains one or more scripts) to set the module name. If `name` is not defined, the module's file name will be used.
-
 ## Script Attributes
 
 Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged.

docs/development/release-checklist.md

@@ -86,15 +86,7 @@ This will automatically update the schema file at `contrib/generated_schema.json
 
 ### Update & Compile Translations
 
-Log into [Transifex](https://app.transifex.com/netbox-community/netbox/dashboard/) to download the updated string maps. Download the resource (portable object, or `.po`) file for each language and save them to `netbox/translations/$lang/LC_MESSAGES/django.po`, overwriting the current files. (Be sure to click the **Download for use** link.)
-
-![Transifex download](../media/development/transifex_download.png)
-
-Once the resource files for all languages have been updated, compile the machine object (`.mo`) files using the `compilemessages` management command:
-
-```nohighlight
-./manage.py compilemessages
-```
+Updated language translations should be pulled from [Transifex](https://app.transifex.com/netbox-community/netbox/dashboard/) and re-compiled for each new release. Follow the documented process for [updating translated strings](./translations.md#updating-translated-strings) to do this.
 
 ### Update Version and Changelog
 

docs/development/translations.md

@@ -6,17 +6,38 @@ All language translations in NetBox are generated from the source file found at
 
 Reviewers log into Transifex and navigate to their designated language(s) to translate strings. The initial translation for most strings will be machine-generated via the AWS Translate service. Human reviewers are responsible for reviewing these translations and making corrections where necessary.
 
-Immediately prior to each NetBox release, the translation maps for all completed languages will be downloaded from Transifex, compiled, and checked into the NetBox code base by a maintainer.
-
 ## Updating Translation Sources
 
-To update the English `.po` file from which all translations are derived, use the `makemessages` management command:
+To update the English `.po` file from which all translations are derived, use the `makemessages` management command (ignoring the `project-static/` directory):
+
+```nohighlight
+./manage.py makemessages -l en -i "project-static/*"
+```
+
+Then, commit the change and push to the `develop` branch on GitHub. Any new strings will appear for translation on Transifex automatically.
+
+## Updating Translated Strings
+
+Typically, translated strings need to be updated only as part of the NetBox [release process](./release-checklist.md).
+
+To update translated strings, start by initiating a sync from Transifex. From the Transifex dashboard, navigate to Settings > Integrations > GitHub > Manage, and click the **Manual Sync** button at top right.
+
+![Transifex manual sync](../media/development/transifex_sync.png)
+
+Enter a threshold percentage of 1 (to ensure all translations are captured) and select the `develop` branch, then click **Sync**. This will initiate a pull request to GitHub to update any newly modified translation (`.po`) files.
+
+!!! tip
+    The new PR should appear within a few minutes. If it does not, check that there are in fact new translations to be added.
+
+![Transifex pull request](../media/development/transifex_pull_request.png)
+
+Once the PR has been merged, the updated strings need to be compiled into new `.mo` files so they can be used by the application. Update the `develop` branch locally to pull in the changes from the Transifex PR, then run Django's [`compilemessages`](https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-compilemessages) management command:
 
 ```nohighlight
-./manage.py makemessages -l en
+./manage.py compilemessages
 ```
 
-Then, commit the change and push to the `develop` branch on GitHub. After some time, any new strings will appear for translation on Transifex automatically.
+Once any new `.mo` files have been generated, they need to be committed and pushed back up to GitHub. (Again, this is typically done as part of publishing a new NetBox release.)
 
 ## Proposing New Languages