Merge pull request #295 from netboxlabs/release-v0.6.0

Release v0.6.0

Author: jeremystretch

.github/workflows/lint-tests.yaml

@@ -3,8 +3,6 @@ on:
   workflow_dispatch:
   pull_request:
   push:
-    branches:
-      - "!release"
 
 concurrency:
   group: ${{ github.workflow }}

.github/workflows/release.yaml

@@ -2,7 +2,7 @@ name: Release
 
 on:
   release:
-    types: [released]
+    types: [published]
 
 permissions:
   contents: read

LICENSE.md

@@ -1,164 +1,85 @@
-# PolyForm Shield License 1.0.0
-
-<https://polyformproject.org/licenses/shield/1.0.0>
+# NetBox Limited Use License 1.0
 
 ## Acceptance
 
-In order to get any license under these terms, you must agree
-to them as both strict obligations and conditions to all
-your licenses.
+In order to get any license under these terms, you must agree to them as
+both strict obligations and conditions to all your licenses.
 
 ## Copyright License
 
-The licensor grants you a copyright license for the
-software to do everything you might do with the software
-that would otherwise infringe the licensor's copyright
-in it for any permitted purpose.  However, you may
-only distribute the software according to [Distribution
-License](#distribution-license) and make changes or new works
-based on the software according to [Changes and New Works
-License](#changes-and-new-works-license).
-
-## Distribution License
-
-The licensor grants you an additional copyright license
-to distribute copies of the software.  Your license
-to distribute covers distributing the software with
-changes and new works permitted by [Changes and New Works
-License](#changes-and-new-works-license).
-
-## Notices
-
-You must ensure that anyone who gets a copy of any part of
-the software from you also gets a copy of these terms or the
-URL for them above, as well as copies of any plain-text lines
-beginning with `Required Notice:` that the licensor provided
-with the software.  For example:
+NetBox Labs grants you a copyright license to use and modify the software
+only as part of a NetBox installation obtained from NetBox Labs or a NetBox
+distributor authorized by NetBox Labs, and only for your own internal use.
 
-> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
-
-## Changes and New Works License
-
-The licensor grants you an additional copyright license to
-make changes and new works based on the software for any
-permitted purpose.
+For clarity, this license grants no rights to distribute the software or
+make it available to others as part of a commercial offering.
 
 ## Patent License
 
-The licensor grants you a patent license for the software that
-covers patent claims the licensor can license, or becomes able
-to license, that you would infringe by using the software.
-
-## Noncompete
-
-Any purpose is a permitted purpose, except for providing any
-product that competes with the software or any product the
-licensor or any of its affiliates provides using the software.
-
-## Competition
+NetBox Labs grants you a patent license for the software that covers patent
+claims the licensor can license, or becomes able to license, that you would
+infringe by using the software, as allowed in the copyright license above.
 
-Goods and services compete even when they provide functionality
-through different kinds of interfaces or for different technical
-platforms.  Applications can compete with services, libraries
-with plugins, frameworks with development tools, and so on,
-even if they're written in different programming languages
-or for different computer architectures.  Goods and services
-compete even when provided free of charge.  If you market a
-product as a practical substitute for the software or another
-product, it definitely competes.
-
-## New Products
-
-If you are using the software to provide a product that does
-not compete, but the licensor or any of its affiliates brings
-your product into competition by providing a new version of
-the software or another product using the software, you may
-continue using versions of the software available under these
-terms beforehand to provide your competing product, but not
-any later versions.
-
-## Discontinued Products
-
-You may begin using the software to compete with a product
-or service that the licensor or any of its affiliates has
-stopped providing, unless the licensor includes a plain-text
-line beginning with `Licensor Line of Business:` with the
-software that mentions that line of business.  For example:
-
-> Licensor Line of Business: YoyodyneCMS Content Management
-System (http://example.com/cms)
+## Patent Defense
 
-## Sales of Business
+If you make any written claim that the software infringes or contributes to
+infringement of any patent, your patent license for the software granted
+under these terms ends immediately. If your company makes such a claim,
+your patent license ends immediately for work on behalf of your company.
+Competitive Restrictions
 
-If the licensor or any of its affiliates sells a line of
-business developing the software or using the software
-to provide a product, the buyer can also enforce
-[Noncompete](#noncompete) for that product.
+This license does not grant you the right to use the software:
 
-## Fair Use
+- To provide a managed service or software products that includes, integrates
+  with, or extends NetBox in a way that competes with any product or service
+  of NetBox Labs.
 
-You may have "fair use" rights for the software under the
-law. These terms do not limit them.
+- To assist or enable a third party in offering a service or product that
+  competes with any product or service of NetBox Labs.
 
 ## No Other Rights
 
-These terms do not allow you to sublicense or transfer any of
-your licenses to anyone else, or prevent the licensor from
-granting licenses to anyone else.  These terms do not imply
-any other licenses.
-
-## Patent Defense
-
-If you make any written claim that the software infringes or
-contributes to infringement of any patent, your patent license
-for the software granted under these terms ends immediately. If
-your company makes such a claim, your patent license ends
-immediately for work on behalf of your company.
+These terms do not allow you to sublicense or transfer any of your licenses
+to anyone else, or prevent NetBox Labs from granting licenses to anyone else.
+These terms do not imply any other licenses.
 
 ## Violations
 
-The first time you are notified in writing that you have
-violated any of these terms, or done anything with the software
-not covered by your licenses, your licenses can nonetheless
-continue if you come into full compliance with these terms,
-and take practical steps to correct past violations, within
-32 days of receiving notice.  Otherwise, all your licenses
-end immediately.
+The first time you are notified in writing that you have violated any of
+these terms, or done anything with the software not covered by your licenses,
+your licenses can nonetheless continue if you come into full compliance with
+these terms, and take practical steps to correct past violations, within 30
+days of receiving notice.  Otherwise, all your licenses end immediately.
 
 ## No Liability
 
-***As far as the law allows, the software comes as is, without
-any warranty or condition, and the licensor will not be liable
-to you for any damages arising out of these terms or the use
-or nature of the software, under any kind of legal claim.***
+As far as the law allows, the software comes as is, without any warranty or
+condition, and NetBox Labs will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.
+
+If this disclaimer is unenforceable under applicable law, this license is void.
 
 ## Definitions
 
-The **licensor** is the individual or entity offering these
-terms, and the **software** is the software the licensor makes
-available under these terms.
+**NetBox Labs** is NetBox Labs, Inc.
 
-A **product** can be a good or service, or a combination
-of them.
+**NetBox** is the community edition of NetBox found at
+<https://github.com/netbox-community/netbox> or any derivative thereof.
 
-**You** refers to the individual or entity agreeing to these
-terms.
+The **software** is the software NetBox Labs makes available under these terms.
 
-**Your company** is any legal entity, sole proprietorship,
-or other kind of organization that you work for, plus all
-its affiliates.
+**You** refers to the individual or entity agreeing to these terms.
 
-**Affiliates** means the other organizations than an
-organization has control over, is under the control of, or is
-under common control with.
+**Your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that organization.
 
-**Control** means ownership of substantially all the assets of
-an entity, or the power to direct its management and policies
-by vote, contract, or otherwise.  Control can be direct or
-indirect.
+**Control** means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
 
-**Your licenses** are all the licenses granted to you for the
-software under these terms.
+**Your licenses** are all the licenses granted to you for the software under
+these terms.
 
-**Use** means anything you do with the software requiring one
-of your licenses.
+**Use** means anything you do with the software requiring one of your licenses.

docs/changelog.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## v0.6.0
+
+### Enhancements
+
+* [#1](https://github.com/netboxlabs/netbox-branching/issues/1) - Enable the application of database migrations to open branches
+* [#122](https://github.com/netboxlabs/netbox-branching/issues/122) - Implement a mechanism to enforce policy before executing branch actions
+* [#181](https://github.com/netboxlabs/netbox-branching/issues/181) - Introduce the `main_schema` configuration parameter to set the default schema name
+* [#189](https://github.com/netboxlabs/netbox-branching/issues/189) - Introduce a registration mechanism for pre-action branch validators
+
+### Bug Fixes
+
+* [#204](https://github.com/netboxlabs/netbox-branching/issues/204) - Hide navigation menu items for unauthenticated users
+
+---
+
 ## v0.5.7
 
 ### Bug Fixes

docs/configuration.md

@@ -28,6 +28,14 @@ exempt_models = (
 
 ---
 
+## `main_schema`
+
+Default: `"public"`
+
+The name of the main (primary) PostgreSQL schema. (Use the `\dn` command in the PostgreSQL CLI to list all schemas.)
+
+---
+
 ## `max_working_branches`
 
 Default: None
@@ -46,8 +54,40 @@ The maximum total number of branches that can exist simultaneously, including me
 
 ## `schema_prefix`
 
-Default: `branch_`
+Default: `"branch_"`
 
 The string to prefix to the unique branch ID when provisioning the PostgreSQL schema for a branch. Per [the PostgreSQL documentation](https://www.postgresql.org/docs/16/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS), this string must begin with a letter or underscore.
 
 Note that a valid prefix is required, as the randomly-generated branch ID alone may begin with a digit, which would not qualify as a valid schema name.
+
+---
+
+## `sync_validators`
+
+Default: `[]` (empty list)
+
+A list of import paths to functions which validate whether a branch is permitted to be synced.
+
+---
+
+## `merge_validators`
+
+Default: `[]` (empty list)
+
+A list of import paths to functions which validate whether a branch is permitted to be merged.
+
+---
+
+## `revert_validators`
+
+Default: `[]` (empty list)
+
+A list of import paths to functions which validate whether a branch is permitted to be reverted.
+
+---
+
+## `archive_validators`
+
+Default: `[]` (empty list)
+
+A list of import paths to functions which validate whether a branch is permitted to be archived.

docs/models/branch.md

@@ -20,17 +20,23 @@ The unique, randomly-generated identifier of the PostgreSQL schema which houses
 
 The current status of the branch. This must be one of the following values.
 
-| Status       | Description                                                       |
-|--------------|-------------------------------------------------------------------|
-| New          | Not yet provisioned in the database                               |
-| Provisioning | A job is running to provision the branch's PostgreSQL schema      |
-| Ready        | The branch is healthy and ready to be synchronized or merged      |
-| Syncing      | A job is running to synchronize changes from main into the branch |
-| Merging      | A job is running to merge changes from the branch into main       |
-| Reverting    | A job is running to revert previously merged changes in main      |
-| Merged       | Changes from this branch have been successfully merged into main  |
-| Archived     | A merged branch which has been deprovisioned in the database      |
-| Failed       | Provisioning the schema for this branch has failed                |
+| Status             | Description                                                                   |
+|--------------------|-------------------------------------------------------------------------------|
+| New                | Not yet provisioned in the database                                           |
+| Provisioning       | A job is running to provision the branch's PostgreSQL schema                  |
+| Ready              | The branch is healthy and ready to be synchronized or merged                  |
+| Syncing            | A job is running to synchronize changes from main into the branch             |
+| Migrating          | A job is running to apply database migrations to the branch schema            |
+| Merging            | A job is running to merge changes from the branch into main                   |
+| Reverting          | A job is running to revert previously merged changes in main                  |
+| Pending Migrations | One or more database migrations must be applied before the branch can be used |
+| Merged             | Changes from this branch have been successfully merged into main              |
+| Archived           | A merged branch which has been deprovisioned in the database                  |
+| Failed             | Provisioning the schema for this branch has failed                            |
+
+### Applied Migrations
+
+A list of database migrations which have been applied to the branch since it was created. This may be necessary to keep open branches up to date during NetBox upgrades.
 
 ### Last Sync