Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 67c0369018 | |||
| a36ed3deba | |||
| d750e7325c | |||
| 3d0093e1fd | |||
| 299ebc21a9 | |||
| ad2f07db5f | |||
| d6fe498652 | |||
| faf5ff8fa1 | |||
| 897203dd8f | |||
| b5a919b8c5 | |||
| 5f4a8f1919 | |||
| 12a03dbb9a | |||
| 6f372e0dfe | |||
| 0adb94f59e | |||
| ee2bcbeed5 | |||
| 3883a5042d | |||
| c034b7e709 | |||
| a803799502 | |||
| 01b437e6ed | |||
| e6ced0d3d1 | |||
| 73ce6e9e31 | |||
| ae91f57bbe | |||
| 66e080ed34 | |||
| d8d9dbfe7f | |||
| aead20fae4 | |||
| c5a2ddee7a | |||
| 418fefdeef |
50
AGENTS.md
50
AGENTS.md
@@ -1,35 +1,25 @@
|
|||||||
Please review `docs/development.md` for initial orientation in this repository
|
<!-- codebase-memory-mcp:start -->
|
||||||
and follow its task-specific reading guide.
|
# Codebase Knowledge Graph (codebase-memory-mcp)
|
||||||
|
|
||||||
## Implementation Discipline
|
This project uses codebase-memory-mcp to maintain a knowledge graph of the codebase.
|
||||||
|
ALWAYS prefer MCP graph tools over grep/glob/file-search for code discovery.
|
||||||
|
|
||||||
Simplify the mechanism, not the user's choices.
|
## Priority Order
|
||||||
|
1. `search_graph` — find functions, classes, routes, variables by pattern
|
||||||
|
2. `trace_path` — trace who calls a function or what it calls
|
||||||
|
3. `get_code_snippet` — read specific function/class source code
|
||||||
|
4. `query_graph` — run Cypher queries for complex patterns
|
||||||
|
5. `get_architecture` — high-level project summary
|
||||||
|
|
||||||
**Keep implementation machinery proportionate.** Use straightforward,
|
## When to fall back to grep/glob
|
||||||
idiomatic code and introduce only the machinery needed to support the requested
|
- Searching for string literals, error messages, config values
|
||||||
behavior and flexibility. Optimize for conceptual simplicity and
|
- Searching non-code files (Dockerfiles, shell scripts, configs)
|
||||||
maintainability, not for the fewest lines, fewest options, or narrowest product
|
- When MCP tools return insufficient results
|
||||||
surface.
|
<!-- codebase-memory-mcp:end -->
|
||||||
|
|
||||||
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
Start with `docs/development.md` for orientation and use its policy reading guide
|
||||||
harden, or otherwise narrow behavior unless required by the user, an explicit
|
to select the policies applicable to the task. Do not read the entire suite by
|
||||||
repository contract, or an unavoidable correctness constraint. Preserve
|
default.
|
||||||
operator and caller choice where policy has not been established. If an
|
|
||||||
additional restriction appears advisable, present it as a decision rather than
|
|
||||||
silently implementing it.
|
|
||||||
|
|
||||||
A correctness constraint must follow from the requested behavior or an
|
Read and follow `docs/policy/agents.md` before recommending, planning, or
|
||||||
established invariant, not from the convenience of the chosen implementation.
|
implementing repository changes.
|
||||||
Explain the specific failure it prevents and why a less restrictive
|
|
||||||
implementation cannot satisfy the contract.
|
|
||||||
|
|
||||||
**An implementation detail is not repository policy.** Tests and documentation
|
|
||||||
must not elevate incidental behavior into a durable guarantee or restriction
|
|
||||||
unless that behavior was expressly selected as part of the contract. Existing
|
|
||||||
explicit contracts remain authoritative; changing or weakening one requires a
|
|
||||||
deliberate decision rather than being inferred from this principle.
|
|
||||||
|
|
||||||
Agent-authored plans, tests, documentation, and prior implementations are not
|
|
||||||
evidence that an additional restriction was deliberately approved. Identify the
|
|
||||||
authorizing requirement or decision; when that authority is unclear, surface
|
|
||||||
the ambiguity rather than treating repetition as approval.
|
|
||||||
|
|||||||
25
COPYRIGHT
Normal file
25
COPYRIGHT
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
ConfigKit
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
This library is free software: you can redistribute it and/or modify it
|
||||||
|
under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
The GNU Lesser General Public License version 3 and its incorporated
|
||||||
|
GNU General Public License version 3 text are provided in LICENSE.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Lesser General Public License for more details.
|
||||||
|
|
||||||
|
Third-party code and assets are subject to their respective license terms.
|
||||||
|
|
||||||
|
Policy documents adapted from Standard Repository Policies, the root AGENTS.md
|
||||||
|
orientation, and the Policy Reading Guide in docs/development.md remain licensed
|
||||||
|
under CC-BY-SA-4.0. See docs/oss/attribution.md for the affected material,
|
||||||
|
upstream credit, and license links.
|
||||||
800
LICENSE
800
LICENSE
@@ -1,304 +1,840 @@
|
|||||||
GNU LESSER GENERAL PUBLIC LICENSE
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
0. Additional Definitions.
|
0. Additional Definitions.
|
||||||
|
|
||||||
As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License.
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version".
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
1. Exception to Section 3 of the GNU GPL.
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
2. Conveying Modified Versions.
|
2. Conveying Modified Versions.
|
||||||
If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
|
|
||||||
|
|
||||||
a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
3. Object Code Incorporating Material from Library Header Files.
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
b) Accompany the object code with a copy of the GNU GPL and this license document.
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
4. Combined Works.
|
4. Combined Works.
|
||||||
You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
|
|
||||||
|
|
||||||
a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
d) Do one of the following:
|
d) Do one of the following:
|
||||||
|
|
||||||
0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
5. Combined Libraries.
|
5. Combined Libraries.
|
||||||
You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
|
|
||||||
|
|
||||||
a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
6. Revised Versions of the GNU Lesser General Public License.
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall
|
Each version is given a distinguishing version number. If the
|
||||||
apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
GNU GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Preamble
|
Preamble
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and modification follow.
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
0. Definitions.
|
0. Definitions.
|
||||||
|
|
||||||
“This License” refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
1. Source Code.
|
1. Source Code.
|
||||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
|
||||||
|
|
||||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that same work.
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
2. Basic Permissions.
|
2. Basic Permissions.
|
||||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
4. Conveying Verbatim Copies.
|
||||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
5. Conveying Modified Source Versions.
|
||||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
6. Conveying Non-Source Forms.
|
||||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
7. Additional Terms.
|
7. Additional Terms.
|
||||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
8. Termination.
|
8. Termination.
|
||||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
9. Acceptance Not Required for Having Copies.
|
||||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
11. Patents.
|
11. Patents.
|
||||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
|
||||||
|
|
||||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
12. No Surrender of Others' Freedom.
|
||||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
13. Use with the GNU Affero General Public License.
|
||||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
14. Revised Versions of this License.
|
||||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
15. Disclaimer of Warranty.
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
16. Limitation of Liability.
|
16. Limitation of Liability.
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
17. Interpretation of Sections 15 and 16.
|
||||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
ConfigKit
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
Copyright (C) 2026 eric
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
ConfigKit Copyright (C) 2026 eric
|
<program> Copyright (C) <year> <name of author>
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -8,14 +8,14 @@ Linux is release-validated; macOS support is best-effort. See the
|
|||||||
ConfigKit's initial loader accepts one strict YAML
|
ConfigKit's initial loader accepts one strict YAML
|
||||||
source (or explicit defaults-only input), optionally traverses explicit path and glob
|
source (or explicit defaults-only input), optionally traverses explicit path and glob
|
||||||
imports, strictly composes their disjoint definitions, applies typed defaults, and
|
imports, strictly composes their disjoint definitions, applies typed defaults, and
|
||||||
can overlay one selected fixed profile and check an application schema version. It
|
can overlay one selected fixed overlay and check an application schema version. It
|
||||||
returns detached metadata and safe diagnostics.
|
returns detached metadata and safe diagnostics.
|
||||||
Applications may perform audited defaulting and normalization through a resolver,
|
Applications may perform audited defaulting and normalization through a resolver,
|
||||||
then report domain errors and warnings through read-only semantic validation. Secret
|
then report domain errors and warnings through read-only semantic validation. Secret
|
||||||
tags and a path predicate drive deterministic redacted effective YAML. Typed secret
|
tags and a path predicate drive deterministic redacted effective YAML. Typed secret
|
||||||
references resolve environment names before validation, and explicit
|
references resolve environment names before validation, and explicit
|
||||||
secrets-directory bootstrap is available as a separate startup operation. Explicit
|
secrets-directory bootstrap is available as a separate startup operation. Explicit
|
||||||
CLI override records apply above profiles. Value explanation is available through
|
CLI override records apply above overlays. Value explanation is available through
|
||||||
detached structured records and deterministic redacted output.
|
detached structured records and deterministic redacted output.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -40,3 +40,7 @@ The [deferred scope](docs/roadmap/deferred.md) records deliberate exclusions. Se
|
|||||||
[development guide](docs/development.md) for repository orientation and the
|
[development guide](docs/development.md) for repository orientation and the
|
||||||
[release procedure](docs/release.md) for maintainer-only candidate and publication
|
[release procedure](docs/release.md) for maintainer-only candidate and publication
|
||||||
steps.
|
steps.
|
||||||
|
|
||||||
|
ConfigKit code is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
|||||||
2
doc.go
2
doc.go
@@ -2,7 +2,7 @@
|
|||||||
// loading for Go programs.
|
// loading for Go programs.
|
||||||
//
|
//
|
||||||
// Load supports file, byte, reader, and explicit no-input sources with strict YAML,
|
// Load supports file, byte, reader, and explicit no-input sources with strict YAML,
|
||||||
// typed defaults, imports, profiles, CLI overrides, schema-version checks, detached
|
// typed defaults, imports, overlays, CLI overrides, schema-version checks, detached
|
||||||
// metadata, recorded application resolution, typed secret references, safe effective
|
// metadata, recorded application resolution, typed secret references, safe effective
|
||||||
// rendering, read-only semantic validation, and structured load errors. The
|
// rendering, read-only semantic validation, and structured load errors. The
|
||||||
// configuration contract is documented in docs/config.md.
|
// configuration contract is documented in docs/config.md.
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ The zero `Source` is invalid. Constructor argument failures are retained inside
|
|||||||
opaque source and become safe structured diagnostics when the source is consumed.
|
opaque source and become safe structured diagnostics when the source is consumed.
|
||||||
File sources can observe file changes between consumptions; byte sources cannot.
|
File sources can observe file changes between consumptions; byte sources cannot.
|
||||||
|
|
||||||
Each source is limited to 8 MiB. A load using imports or an active profile is limited
|
Each source is limited to 8 MiB. A load using imports or an active overlay is limited
|
||||||
to 64 MiB across all accepted sources, 1,024 accepted sources, 64 active import
|
to 64 MiB across all accepted sources, 1,024 accepted sources, 64 active import
|
||||||
edges, and 1,000,000 input nodes in aggregate. Glob expansion separately permits
|
edges, and 1,000,000 input nodes in aggregate. Glob expansion separately permits
|
||||||
1,000,000 visited directory entries, including nonmatches. Reads request at most the
|
1,000,000 visited directory entries, including nonmatches. Reads request at most the
|
||||||
@@ -33,7 +33,7 @@ truncated. Data returned together with a read error is not accepted as partial i
|
|||||||
root `T` must satisfy the application schema contract below. With no options it
|
root `T` must satisfy the application schema contract below. With no options it
|
||||||
starts from the Go zero value. A `Definition[T].Defaults` factory, when supplied,
|
starts from the Go zero value. A `Definition[T].Defaults` factory, when supplied,
|
||||||
runs exactly once after successful source parsing, schema construction, optional
|
runs exactly once after successful source parsing, schema construction, optional
|
||||||
schema-version checking, and selected-profile loading. Its result is detached before
|
schema-version checking, and selected-overlay loading. Its result is detached before
|
||||||
input is applied. Resolver-provided mutable values are detached before secret lookup
|
input is applied. Resolver-provided mutable values are detached before secret lookup
|
||||||
and validation, and a final detached copy prevents equal-valued aliases introduced
|
and validation, and a final detached copy prevents equal-valued aliases introduced
|
||||||
by validators from escaping into the returned configuration. The publication copy
|
by validators from escaping into the returned configuration. The publication copy
|
||||||
@@ -43,7 +43,7 @@ The current lifecycle is:
|
|||||||
|
|
||||||
```text
|
```text
|
||||||
validate options → parse the selected source → traverse/compose enabled imports
|
validate options → parse the selected source → traverse/compose enabled imports
|
||||||
→ build schema → check the optional application version → apply a selected profile
|
→ build schema → check the optional application version → apply a selected overlay
|
||||||
→ apply explicit CLI overrides → create and clone defaults → strictly decode
|
→ apply explicit CLI overrides → create and clone defaults → strictly decode
|
||||||
→ recorded application resolution
|
→ recorded application resolution
|
||||||
→ resolve typed secret references → semantic validation → classify secrets
|
→ resolve typed secret references → semantic validation → classify secrets
|
||||||
@@ -57,9 +57,9 @@ contributes no source, and continues through defaults, decode, and projection. A
|
|||||||
missing file remains an error; it is never interpreted as no input.
|
missing file remains an error; it is never interpreted as no input.
|
||||||
|
|
||||||
The current `Options` boundary accepts a defaults factory, `VersionRule`, resolver,
|
The current `Options` boundary accepts a defaults factory, `VersionRule`, resolver,
|
||||||
semantic validator, explicit path and glob imports, one selected profile, and
|
semantic validator, explicit path and glob imports, one selected overlay, and
|
||||||
filesystem context. It also accepts explicit CLI override records, static secret
|
filesystem context. It also accepts explicit CLI override records, static secret
|
||||||
tags, and a dynamic path predicate. `NoSource` rejects imports, active profiles,
|
tags, and a dynamic path predicate. `NoSource` rejects imports, active overlays,
|
||||||
and filesystem context as invalid combinations but accepts overrides. Input
|
and filesystem context as invalid combinations but accepts overrides. Input
|
||||||
containing a reserved `configkit` mapping key is rejected while imports are
|
containing a reserved `configkit` mapping key is rejected while imports are
|
||||||
disabled.
|
disabled.
|
||||||
@@ -93,7 +93,7 @@ This is a load-local exception: siblings and unrelated fields, dynamic values,
|
|||||||
integer and float destinations, durations, `Secret`, and text codecs retain ordinary
|
integer and float destinations, durations, `Secret`, and text codecs retain ordinary
|
||||||
strict decoding. The retained source and history stay numeric while typed projection
|
strict decoding. The retained source and history stay numeric while typed projection
|
||||||
and effective YAML contain the resulting string; explanation records this through
|
and effective YAML contain the resulting string; explanation records this through
|
||||||
the normal decoding reconciliation event. Fragment, profile, and CLI ownership
|
the normal decoding reconciliation event. Fragment, overlay, and CLI ownership
|
||||||
protections apply before this conversion.
|
protections apply before this conversion.
|
||||||
|
|
||||||
The checker reports safe, value-free errors and warnings through `Validation.Error`
|
The checker reports safe, value-free errors and warnings through `Validation.Error`
|
||||||
@@ -109,11 +109,11 @@ successful result. Callback panics remain programming failures.
|
|||||||
key/index distinctions using actual effective and historical container shapes;
|
key/index distinctions using actual effective and historical container shapes;
|
||||||
only parsed numeric tokens are resolved contextually. A descendant that never
|
only parsed numeric tokens are resolved contextually. A descendant that never
|
||||||
existed is not historical merely because an atomic ancestor was replaced. Exact surviving input paths
|
existed is not historical merely because an atomic ancestor was replaced. Exact surviving input paths
|
||||||
are explicit and have a base or profile origin; omitted paths have a default origin.
|
are explicit and have a base or overlay origin; omitted paths have a default origin.
|
||||||
An explicit parent mapping does not make omitted children explicit. Null state and
|
An explicit parent mapping does not make omitted children explicit. Null state and
|
||||||
available source coordinates are retained. `History` records the Go-zero or application
|
available source coordinates are retained. `History` records the Go-zero or application
|
||||||
default baseline followed by exact base or profile definitions, including
|
default baseline followed by exact base or overlay definitions, including
|
||||||
equal-valued input. Profile replacement removes displaced descendants from effective
|
equal-valued input. Overlay replacement removes displaced descendants from effective
|
||||||
metadata while retaining their base definition and the parent replacement operation
|
metadata while retaining their base definition and the parent replacement operation
|
||||||
in history. All metadata queries and returned nested records are detached.
|
in history. All metadata queries and returned nested records are detached.
|
||||||
|
|
||||||
@@ -125,21 +125,21 @@ documentation in [metadata.go](../metadata.go) defines enumeration and path-orde
|
|||||||
details.
|
details.
|
||||||
|
|
||||||
History is chronological: a path can have a synthetic default record, its exact base
|
History is chronological: a path can have a synthetic default record, its exact base
|
||||||
definition, a profile replacement, and a recorded resolution operation. A descendant
|
definition, an overlay replacement, and a recorded resolution operation. A descendant
|
||||||
query uses the ancestor's path for a whole-container or whole-sequence replacement;
|
query uses the ancestor's path for a whole-container or whole-sequence replacement;
|
||||||
the descendant can therefore retain history after `Lookup` stops reporting it as
|
the descendant can therefore retain history after `Lookup` stops reporting it as
|
||||||
effective. Equal-valued input is still an explicit base definition, while a derived
|
effective. Equal-valued input is still an explicit base definition, while a derived
|
||||||
value for absent input remains non-explicit.
|
value for absent input remains non-explicit.
|
||||||
|
|
||||||
A mapping assembled from the selected file and imports has one composite base origin
|
A mapping assembled from the selected file and imports has one composite base origin
|
||||||
whose locations retain source traversal order. A mapping also visited by a profile
|
whose locations retain source traversal order. A mapping also visited by an overlay
|
||||||
has a profile-layer composite origin with the lower contributing locations followed
|
has an overlay-layer composite origin with the lower contributing locations followed
|
||||||
by the profile location; an empty mapping is still an explicit container even though
|
by the overlay location; an empty mapping is still an explicit container even though
|
||||||
it contributes no children. Resolution origins are synthetic: they have layer
|
it contributes no children. Resolution origins are synthetic: they have layer
|
||||||
`resolution`, no fabricated file location, and a `derived_default` or `normalization`
|
`resolution`, no fabricated file location, and a `derived_default` or `normalization`
|
||||||
operation. Reasons and dependency paths retain first occurrence order with duplicates
|
operation. Reasons and dependency paths retain first occurrence order with duplicates
|
||||||
removed. Source records remain ordered as selected source, depth-first imports, the
|
removed. Source records remain ordered as selected source, depth-first imports, the
|
||||||
selected profile, then synthetic CLI records in supplied order.
|
selected overlay, then synthetic CLI records in supplied order.
|
||||||
|
|
||||||
### Secret classification and effective rendering
|
### Secret classification and effective rendering
|
||||||
|
|
||||||
@@ -189,7 +189,7 @@ historical path. Its effective value and each chronological before/after value a
|
|||||||
parser values. `Present=false` with empty YAML means absence or deletion; explicit
|
parser values. `Present=false` with empty YAML means absence or deletion; explicit
|
||||||
null is present and renders as `null`. The history starts with the canonical typed
|
null is present and renders as `null`. The history starts with the canonical typed
|
||||||
application-default or Go-zero baseline, then includes only relevant base sources in
|
application-default or Go-zero baseline, then includes only relevant base sources in
|
||||||
traversal order, the selected profile, supplied CLI records, and audited net
|
traversal order, the selected overlay, supplied CLI records, and audited net
|
||||||
resolution operations. Overlapping parent/child resolution records are rendered
|
resolution operations. Overlapping parent/child resolution records are rendered
|
||||||
as one net subtree event with combined reasons and dependencies, rather than
|
as one net subtree event with combined reasons and dependencies, rather than
|
||||||
pretending that the recorded assignments ran in lexical order. Explicit equal
|
pretending that the recorded assignments ran in lexical order. Explicit equal
|
||||||
@@ -199,7 +199,7 @@ before domain resolution. Its origin retains the decoded path's source/default
|
|||||||
attribution; its reason identifies static-default retention and canonical decoding.
|
attribution; its reason identifies static-default retention and canonical decoding.
|
||||||
This built-in inspection operation is not accepted by `Resolution.Record`.
|
This built-in inspection operation is not accepted by `Resolution.Record`.
|
||||||
|
|
||||||
Base, profile, and CLI history preserves the policy-validated input representation,
|
Base, overlay, and CLI history preserves the policy-validated input representation,
|
||||||
including a superseded value that could not have decoded into the final Go field.
|
including a superseded value that could not have decoded into the final Go field.
|
||||||
Baseline, effective, and resolution values use canonical typed projection. A
|
Baseline, effective, and resolution values use canonical typed projection. A
|
||||||
decoding event bridges replayed input and canonical typed values, so intermediate
|
decoding event bridges replayed input and canonical typed values, so intermediate
|
||||||
@@ -338,7 +338,7 @@ found entry path. Resolution changes, additions, removals, and moves do not alte
|
|||||||
this entry view.
|
this entry view.
|
||||||
|
|
||||||
`Resolution.Source(id)` returns a detached record for an already acquired source in
|
`Resolution.Source(id)` returns a detached record for an already acquired source in
|
||||||
the same load: the main source, imports, selected profile, and supplied CLI records
|
the same load: the main source, imports, selected overlay, and supplied CLI records
|
||||||
where applicable. Empty and unknown IDs return false. It never reloads input, reads
|
where applicable. Empty and unknown IDs return false. It never reloads input, reads
|
||||||
the filesystem, resolves symlinks, or looks up credentials. A source path exists
|
the filesystem, resolves symlinks, or looks up credentials. A source path exists
|
||||||
only when the acquired source has one; defaults and byte, reader, and CLI sources do
|
only when the acquired source has one; defaults and byte, reader, and CLI sources do
|
||||||
@@ -436,41 +436,41 @@ traversal order. Traversal order never authorizes replacement. Composition clone
|
|||||||
the resulting tree and its ordered claim records rather than mutating or aliasing an
|
the resulting tree and its ordered claim records rather than mutating or aliasing an
|
||||||
input document.
|
input document.
|
||||||
|
|
||||||
## Selected profiles
|
## Selected overlays
|
||||||
|
|
||||||
`Options.Profile` selects at most one overlay by name. Names must match
|
`Options.Overlay` selects at most one overlay by name. Names must match
|
||||||
`[a-zA-Z0-9_-]+`; they are not paths. The empty name and exact lowercase name
|
`[a-zA-Z0-9_-]+`; they are not paths. The empty name and exact lowercase name
|
||||||
`default` select no profile, and `profiles/default.yml` is never loaded implicitly.
|
`default` select no overlay, and `overlays/default.yml` is never loaded implicitly.
|
||||||
Every other name resolves only to `<configuration-root>/profiles/<name>.yml`, with
|
Every other name resolves only to `<configuration-root>/overlays/<name>.yml`, with
|
||||||
no extension fallback, case normalization, inheritance, or profile stack. A selected
|
no extension fallback, case normalization, inheritance, or overlay stack. A selected
|
||||||
missing profile is an error.
|
missing overlay is an error.
|
||||||
|
|
||||||
The profile is a separately policy-validated YAML mapping. It is loaded after the
|
The overlay is a separately policy-validated YAML mapping. It is loaded after the
|
||||||
base import graph is composed and its schema version is checked, but before defaults
|
base import graph is composed and its schema version is checked, but before defaults
|
||||||
and typed decoding. Profile bytes, nodes, and source records count toward the same
|
and typed decoding. Overlay bytes, nodes, and source records count toward the same
|
||||||
aggregate limits as base inputs. Its canonical path must remain within the configured
|
aggregate limits as base inputs. Its canonical path must remain within the configured
|
||||||
root and must not duplicate a file already present in the base graph.
|
root and must not duplicate a file already present in the base graph.
|
||||||
|
|
||||||
Overlay is intentionally distinct from strict composition:
|
Overlay is intentionally distinct from strict composition:
|
||||||
|
|
||||||
| Existing lower node | Incoming profile node | Result |
|
| Existing lower node | Incoming overlay node | Result |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| Absent | Value | Retain the profile value |
|
| Absent | Value | Retain the overlay value |
|
||||||
| Value | Absent | Retain the lower value |
|
| Value | Absent | Retain the lower value |
|
||||||
| Mapping | Mapping | Recurse by mapping key |
|
| Mapping | Mapping | Recurse by mapping key |
|
||||||
| Any other pair of present nodes | Any other pair of present nodes | Replace the entire lower node |
|
| Any other pair of present nodes | Any other pair of present nodes | Replace the entire lower node |
|
||||||
|
|
||||||
Scalars, sequences, and null are atomic. Thus a profile sequence replaces rather
|
Scalars, sequences, and null are atomic. Thus an overlay sequence replaces rather
|
||||||
than extends a base sequence, `[]` clears it, null is an explicit replacement, and
|
than extends a base sequence, `[]` clears it, null is an explicit replacement, and
|
||||||
cross-kind replacement is allowed when the final application schema accepts it.
|
cross-kind replacement is allowed when the final application schema accepts it.
|
||||||
Replacing a subtree removes all displaced descendants from effective presence and
|
Replacing a subtree removes all displaced descendants from effective presence and
|
||||||
origin data; history retains the displaced definitions and identifies the parent
|
origin data; history retains the displaced definitions and identifies the parent
|
||||||
replacement. Surviving profile paths have profile origins, while recursively shared
|
replacement. Surviving overlay paths have overlay origins, while recursively shared
|
||||||
mapping containers retain their contributing locations.
|
mapping containers retain their contributing locations.
|
||||||
|
|
||||||
A profile may not contain `configkit` anywhere, contribute the configured schema
|
An overlay may not contain `configkit` anywhere, contribute the configured schema
|
||||||
version, or replace an ancestor of that version with a scalar or null. These rules
|
version, or replace an ancestor of that version with a scalar or null. These rules
|
||||||
apply even if the supplied version text would be unchanged. Profiles cannot mask a
|
apply even if the supplied version text would be unchanged. Overlays cannot mask a
|
||||||
base parse, composition, or version failure because those checks run first.
|
base parse, composition, or version failure because those checks run first.
|
||||||
|
|
||||||
## Explicit CLI overrides
|
## Explicit CLI overrides
|
||||||
@@ -483,8 +483,8 @@ must never contain the raw argument or configured value. General environment
|
|||||||
variable overlays are an explicit non-goal: environment access is reserved for
|
variable overlays are an explicit non-goal: environment access is reserved for
|
||||||
typed secret references.
|
typed secret references.
|
||||||
|
|
||||||
Overrides apply after the selected profile and before typed defaults/decoding, so
|
Overrides apply after the selected overlay and before typed defaults/decoding, so
|
||||||
the input precedence is application defaults < composed base < selected profile <
|
the input precedence is application defaults < composed base < selected overlay <
|
||||||
CLI. Recorded resolution, typed secret lookup, and semantic validation follow the
|
CLI. Recorded resolution, typed secret lookup, and semantic validation follow the
|
||||||
effective override tree. Overrides also work with `NoSource`.
|
effective override tree. Overrides also work with `NoSource`.
|
||||||
|
|
||||||
@@ -506,7 +506,7 @@ configured schema-version path. Unknown fields and effective type mismatches rem
|
|||||||
ordinary strict-decoder errors.
|
ordinary strict-decoder errors.
|
||||||
|
|
||||||
At most 1,024 records are accepted, and each record creates one synthetic CLI
|
At most 1,024 records are accepted, and each record creates one synthetic CLI
|
||||||
source after file/profile sources in supplied order. Override sources share the
|
source after file/overlay sources in supplied order. Override sources share the
|
||||||
1,024-source ceiling. A record has an 8 MiB string-byte limit; override strings and
|
1,024-source ceiling. A record has an 8 MiB string-byte limit; override strings and
|
||||||
source bytes share the 64 MiB aggregate limit. Synthetic mapping keys and values
|
source bytes share the 64 MiB aggregate limit. Synthetic mapping keys and values
|
||||||
count toward the existing 1,000,000-node and depth-256 ceilings. Cycles, named or
|
count toward the existing 1,000,000-node and depth-256 ceilings. Cycles, named or
|
||||||
@@ -514,7 +514,7 @@ unsupported types, nonfinite floats, and limit excesses fail with safe `override
|
|||||||
diagnostics. Diagnostics and provenance identify the safe `Flag` source, never raw
|
diagnostics. Diagnostics and provenance identify the safe `Flag` source, never raw
|
||||||
arguments or values.
|
arguments or values.
|
||||||
|
|
||||||
Override origins are explicit CLI origins. History retains replaced base/profile
|
Override origins are explicit CLI origins. History retains replaced base/overlay
|
||||||
definitions and records equal-value replacements as well as structural changes.
|
definitions and records equal-value replacements as well as structural changes.
|
||||||
Caller-owned maps and slices are snapshotted during loading and must not be mutated
|
Caller-owned maps and slices are snapshotted during loading and must not be mutated
|
||||||
concurrently with the call. The executable `ExampleOverride` shows translating a
|
concurrently with the call. The executable `ExampleOverride` shows translating a
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Consumer Adoption Guide
|
# Consumer Adoption Guide
|
||||||
|
|
||||||
ConfigKit removes parser setup, strict decoding, presence bookkeeping, import and
|
ConfigKit removes parser setup, strict decoding, presence bookkeeping, import and
|
||||||
profile traversal, precedence, provenance, secret lookup, and safe inspection from
|
selected-overlay traversal, precedence, provenance, secret lookup, and safe inspection from
|
||||||
applications. Consumers still own their configuration structs, defaults, semantic
|
applications. Consumers still own their configuration structs, defaults, semantic
|
||||||
validation, schema-version policy, CLI parsing, runtime matching and conversion,
|
validation, schema-version policy, CLI parsing, runtime matching and conversion,
|
||||||
resource checks, remote acquisition, and service initialization.
|
resource checks, remote acquisition, and service initialization.
|
||||||
@@ -34,7 +34,7 @@ features appear only when the application needs them:
|
|||||||
result, err := configkit.Load[Config](configkit.File(path), configkit.Options[Config]{
|
result, err := configkit.Load[Config](configkit.File(path), configkit.Options[Config]{
|
||||||
Definition: rules,
|
Definition: rules,
|
||||||
Imports: useDeclaredImports,
|
Imports: useDeclaredImports,
|
||||||
Profile: selectedConfigProfile,
|
Overlay: selectedConfigOverlay,
|
||||||
Overrides: explicitlySetFlags,
|
Overrides: explicitlySetFlags,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -43,8 +43,8 @@ if err != nil {
|
|||||||
return start(result.Config)
|
return start(result.Config)
|
||||||
```
|
```
|
||||||
|
|
||||||
Simple consumers use neither imports nor profiles. A complex consumer can opt into
|
Simple consumers use neither imports nor selected overlays. A complex consumer can opt into
|
||||||
both without redefining their syntax. ConfigKit profiles are configuration overlays;
|
both without redefining their syntax. ConfigKit overlays are configuration overlays;
|
||||||
they do not select or replace an application's LLM, model, pipeline, report, or
|
they do not select or replace an application's LLM, model, pipeline, report, or
|
||||||
execution profile concepts.
|
execution profile concepts.
|
||||||
|
|
||||||
@@ -100,6 +100,16 @@ The examples preserve domain meaning while adopting one configuration convention
|
|||||||
blocked empty variables remain blocked, and ordinary `Load` never changes the
|
blocked empty variables remain blocked, and ordinary `Load` never changes the
|
||||||
process environment.
|
process environment.
|
||||||
|
|
||||||
|
### Selected-overlay migration
|
||||||
|
|
||||||
|
To adopt the current selected-overlay API, rename `Options.Profile`,
|
||||||
|
`LayerProfile`, and `CodeProfile*` references to their `Overlay` equivalents; move
|
||||||
|
selected files from `profiles/<name>.yml` to `overlays/<name>.yml`; update any
|
||||||
|
handling of the `overlay` layer and `overlay.*` diagnostic strings; then rebuild.
|
||||||
|
The [configuration contract](../config.md#selected-overlays) is the canonical
|
||||||
|
behavioral reference. Application-owned profile concepts, such as `model_profile`,
|
||||||
|
are unchanged, and any CLI flag rename remains the application's decision.
|
||||||
|
|
||||||
These examples are migration evidence, not completed changes to Narratio, Notarius,
|
These examples are migration evidence, not completed changes to Narratio, Notarius,
|
||||||
WeatherReporter, or Seriatim. Updating those repositories, their deployed YAML, CLI
|
WeatherReporter, or Seriatim. Updating those repositories, their deployed YAML, CLI
|
||||||
wiring, runtime catalogs, and operational documentation remains separate downstream
|
wiring, runtime catalogs, and operational documentation remains separate downstream
|
||||||
@@ -113,7 +123,7 @@ focused behavioral owner:
|
|||||||
| Roadmap surface | Maintained owner |
|
| Roadmap surface | Maintained owner |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Load`, `NoSource`, validation, versions, resolution, `SecretEnv`, overrides, and explanation | Executable examples in [`example_test.go`](../../example_test.go) |
|
| `Load`, `NoSource`, validation, versions, resolution, `SecretEnv`, overrides, and explanation | Executable examples in [`example_test.go`](../../example_test.go) |
|
||||||
| Source/import/profile pipeline rules and artifact defaults | Narratio-shaped executable example and fixture |
|
| Source/import/selected-overlay pipeline rules and artifact defaults | Narratio-shaped executable example and fixture |
|
||||||
| Canonical module objects and dynamic option handling | WeatherReporter- and Notarius-shaped examples and migration tests |
|
| Canonical module objects and dynamic option handling | WeatherReporter- and Notarius-shaped examples and migration tests |
|
||||||
| `LoadSecretsDir`, bootstrap reporting, typed lookup, CLI explanation | `Example_weatherStartup` |
|
| `LoadSecretsDir`, bootstrap reporting, typed lookup, CLI explanation | `Example_weatherStartup` |
|
||||||
| Results, metadata, diagnostics, effective output, and writer failures | Focused root-package load, provenance, rendering, and explanation tests |
|
| Results, metadata, diagnostics, effective output, and writer failures | Focused root-package load, provenance, rendering, and explanation tests |
|
||||||
|
|||||||
@@ -8,20 +8,43 @@ public behavior.
|
|||||||
## Initial orientation
|
## Initial orientation
|
||||||
|
|
||||||
1. Inspect the working tree and preserve unrelated changes.
|
1. Inspect the working tree and preserve unrelated changes.
|
||||||
2. Read the architecture policy for code or design work.
|
2. Use the Policy Reading Guide below to select applicable policies.
|
||||||
3. Read the policy, contract, and internal documents applicable to the task.
|
3. Read the contract and internal documents applicable to the task.
|
||||||
4. Inspect the relevant implementation and behavioral tests before changing them.
|
4. Inspect the relevant implementation and behavioral tests before changing them.
|
||||||
|
|
||||||
|
## Policy Reading Guide
|
||||||
|
|
||||||
|
| Policy | Read before… |
|
||||||
|
| --- | --- |
|
||||||
|
| [Policy set provenance](policy/meta.md) | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
|
||||||
|
| [Agents](policy/agents.md) | Recommending, planning, or implementing repository changes. |
|
||||||
|
| [Architecture](policy/architecture.md) | Planning or changing Go library code or its structure. |
|
||||||
|
| [Testing](policy/testing.md) | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
|
||||||
|
| [Documentation](policy/documentation.md) | Writing, revising, or reorganizing documentation. |
|
||||||
|
| [OSS](policy/oss.md) | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
|
||||||
|
| [Release](policy/release.md) | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
|
||||||
|
|
||||||
|
- Read applicable policies before making decisions they govern; multiple policies
|
||||||
|
may apply.
|
||||||
|
- Select policies using the task triggers above. Follow cross-references to
|
||||||
|
relevant sections when needed to resolve a concrete question.
|
||||||
|
- Reuse policies already available in context; reread when changed or no longer
|
||||||
|
available.
|
||||||
|
- Expand reading when the task's scope expands.
|
||||||
|
- When revising a policy itself, read that policy and any provisions elsewhere
|
||||||
|
affected by the revision.
|
||||||
|
|
||||||
## Task-specific reading guide
|
## Task-specific reading guide
|
||||||
|
|
||||||
| Task | Read |
|
| Task | Read |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Repository orientation or component responsibility | [Architecture policy](policy/architecture.md) and [component overview](internal/overview.md) |
|
| Repository orientation or component responsibility | [Component overview](internal/overview.md) |
|
||||||
| Documentation changes | [Documentation policy](policy/documentation.md) and the owning document |
|
| Documentation changes | The owning document |
|
||||||
| Architecture decisions or future work | [Documentation policy](policy/documentation.md), [deferred scope](roadmap/deferred.md), and relevant ADRs listed below |
|
| Licensing, dependencies, attribution, or release-document changes | [Project grant](../COPYRIGHT) and [attribution](oss/attribution.md); release changes also follow the release procedure |
|
||||||
| Code and test changes | [Architecture policy](policy/architecture.md), [testing policy](policy/testing.md), and the owning contract and tests from the map below |
|
| Architecture decisions or future work | [Deferred scope](roadmap/deferred.md) and relevant ADRs listed below |
|
||||||
|
| Code and test changes | The owning contract and tests from the map below |
|
||||||
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
||||||
| Release preparation | [Release policy](policy/release.md) and [release procedure](release.md) |
|
| Release preparation | [Release procedure](release.md) |
|
||||||
|
|
||||||
Accepted decisions:
|
Accepted decisions:
|
||||||
|
|
||||||
@@ -41,7 +64,8 @@ git show cb5b435:docs/roadmap/remediation.md
|
|||||||
```
|
```
|
||||||
|
|
||||||
Release-candidate, publication, and verification work follows the operational
|
Release-candidate, publication, and verification work follows the operational
|
||||||
[release procedure](release.md).
|
[release procedure](release.md). Its single publication command validates the
|
||||||
|
committed candidate and publishes only the intended refs.
|
||||||
|
|
||||||
The completed string-and-integer schema-version implementation and remediation
|
The completed string-and-integer schema-version implementation and remediation
|
||||||
records are preserved in Git history at `244104f`. The
|
records are preserved in Git history at `244104f`. The
|
||||||
@@ -56,6 +80,11 @@ and current facade ownership belongs to the [component overview](internal/overvi
|
|||||||
|
|
||||||
## Baseline validation
|
## Baseline validation
|
||||||
|
|
||||||
|
The completed overlay rename plan and release-workflow simplification record are
|
||||||
|
preserved in Git history at `73ce6e9` under `docs/roadmap/`. Current overlay
|
||||||
|
behavior belongs to the [configuration contract](config.md#selected-overlays),
|
||||||
|
and release operations belong to the [release procedure](release.md).
|
||||||
|
|
||||||
Install Go 1.25.0 or a supported patched/newer Go toolchain. Acquire declared
|
Install Go 1.25.0 or a supported patched/newer Go toolchain. Acquire declared
|
||||||
dependencies explicitly before entering an offline development or validation
|
dependencies explicitly before entering an offline development or validation
|
||||||
environment:
|
environment:
|
||||||
@@ -88,8 +117,11 @@ Use focused checks while iterating, with validation proportionate to the change
|
|||||||
under the testing policy. Documentation-only work normally needs the local-link
|
under the testing policy. Documentation-only work normally needs the local-link
|
||||||
check below and whitespace review; behavior-bearing examples and commands also
|
check below and whitespace review; behavior-bearing examples and commands also
|
||||||
need execution. Use `go test -race ./...` for ownership or concurrency changes.
|
need execution. Use `go test -race ./...` for ownership or concurrency changes.
|
||||||
The separate [release checker](release.md#4-validate-the-source-candidate) adds
|
The [publication command](release.md#4-publish-the-committed-candidate) invokes
|
||||||
two-toolchain, module-hygiene, race, and cross-build gates.
|
the release checker once. It performs one minimum-toolchain offline race-suite
|
||||||
|
run, one full vet pass, and Linux cross-builds using readonly module mode.
|
||||||
|
It already covers examples, links, and package boundaries; do not additionally
|
||||||
|
run the everyday checker just to repeat those checks. CI never gates a release.
|
||||||
|
|
||||||
## Task-to-test map
|
## Task-to-test map
|
||||||
|
|
||||||
@@ -101,14 +133,15 @@ code changes. Use the component overview to find the corresponding implementatio
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| YAML syntax, diagnostics, parser limits | [Adapter tests](../internal/yaml/parse_test.go), [source translation](../internal/engine/parse_test.go) | `go test ./internal/yaml` and `go test ./internal/engine -run '^TestParseSource'` |
|
| YAML syntax, diagnostics, parser limits | [Adapter tests](../internal/yaml/parse_test.go), [source translation](../internal/engine/parse_test.go) | `go test ./internal/yaml` and `go test ./internal/engine -run '^TestParseSource'` |
|
||||||
| File/reader access, imports, globs, containment | [Sources](../internal/engine/source_test.go), [FIFO](../internal/engine/source_fifo_test.go), [imports](../internal/engine/imports_test.go), [globs](../internal/engine/glob_test.go) | `go test ./internal/engine -run 'Source\|Import\|Glob\|Filesystem\|Nonregular\|RegularFile'` |
|
| File/reader access, imports, globs, containment | [Sources](../internal/engine/source_test.go), [FIFO](../internal/engine/source_fifo_test.go), [imports](../internal/engine/imports_test.go), [globs](../internal/engine/glob_test.go) | `go test ./internal/engine -run 'Source\|Import\|Glob\|Filesystem\|Nonregular\|RegularFile'` |
|
||||||
| Composition, profiles, CLI precedence | [Composition](../internal/engine/compose_test.go), [overlay](../internal/engine/overlay_test.go), [profiles](../internal/engine/profile_test.go), [overrides](../internal/engine/override_test.go) | `go test ./internal/engine -run 'Compose\|Overlay\|Profile\|Override'` |
|
| Composition, selected overlays, CLI precedence | [Composition](../internal/engine/compose_test.go), [overlay](../internal/engine/overlay_test.go), [selected overlays](../internal/engine/selected_overlay_test.go), [overrides](../internal/engine/override_test.go) | `go test ./internal/engine -run 'Compose\|Overlay\|Override'` |
|
||||||
| Schema, defaults, projection, cloning | [Schema](../internal/engine/schema_test.go), [decoding](../internal/engine/decode_test.go), [projection](../internal/engine/projection_test.go) | `go test ./internal/engine -run 'Schema\|Decode\|Projection\|Clone\|Inline\|CompareDocument'` |
|
| Schema, defaults, projection, cloning | [Schema](../internal/engine/schema_test.go), [decoding](../internal/engine/decode_test.go), [projection](../internal/engine/projection_test.go) | `go test ./internal/engine -run 'Schema\|Decode\|Projection\|Clone\|Inline\|CompareDocument'` |
|
||||||
| Lifecycle, resolution, validation, callback ownership | [Loading](../internal/engine/load_test.go), [resolution](../internal/engine/resolution_test.go), [validation](../internal/engine/validation_test.go), [ownership](../internal/engine/callback_ownership_test.go), [independence](../internal/engine/independence_test.go) | `go test ./internal/engine -run 'Load\|Resolution\|Validation\|Validator\|Hook\|Callback\|Parallel'` |
|
| Lifecycle, resolution, validation, callback ownership | [Loading](../internal/engine/load_test.go), [resolution](../internal/engine/resolution_test.go), [validation](../internal/engine/validation_test.go), [ownership](../internal/engine/callback_ownership_test.go), [independence](../internal/engine/independence_test.go) | `go test ./internal/engine -run 'Load\|Resolution\|Validation\|Validator\|Hook\|Callback\|Parallel'` |
|
||||||
| Paths, metadata, provenance | [Paths](../internal/engine/path_test.go), [metadata](../internal/engine/metadata_test.go), [provenance](../internal/engine/provenance_test.go) | `go test ./internal/engine -run 'Path\|Metadata\|Provenance\|Queries'` |
|
| Paths, metadata, provenance | [Paths](../internal/engine/path_test.go), [metadata](../internal/engine/metadata_test.go), [provenance](../internal/engine/provenance_test.go) | `go test ./internal/engine -run 'Path\|Metadata\|Provenance\|Queries'` |
|
||||||
| Secrets, bootstrap, redaction, explanation | [References](../internal/engine/secret_reference_test.go), [bootstrap](../internal/engine/secrets_test.go), [rendering](../internal/engine/render_test.go), [explanation](../internal/engine/explain_test.go) | `go test ./internal/engine -run 'Secret\|Bootstrap\|Effective\|Explain\|Explanation\|History\|Sensitivity'` |
|
| Secrets, bootstrap, redaction, explanation | [References](../internal/engine/secret_reference_test.go), [bootstrap](../internal/engine/secrets_test.go), [rendering](../internal/engine/render_test.go), [explanation](../internal/engine/explain_test.go) | `go test ./internal/engine -run 'Secret\|Bootstrap\|Effective\|Explain\|Explanation\|History\|Sensitivity'` |
|
||||||
| Consumer examples and migration fixtures | [Consumer tests](../examples/consumers/consumers_test.go), [API examples](../example_test.go) | `go test ./examples/consumers` and `go test . -run '^Example'` |
|
| Consumer examples and migration fixtures | [Consumer tests](../examples/consumers/consumers_test.go), [API examples](../example_test.go) | `go test ./examples/consumers` and `go test . -run '^Example'` |
|
||||||
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go), [public boundary](../public_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks\|TestDependencyImportBoundary\|TestPublicFacadeBoundary'` |
|
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go), [public boundary](../public_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks\|TestDependencyImportBoundary\|TestPublicFacadeBoundary'` |
|
||||||
| Check-command behavior | [Shell regression](../release_check_test.go) | `go test . -run '^TestCheckScripts'` |
|
| Development and release checker behavior | [Shell regression](../release_check_test.go) | `go test . -run 'TestCheckScripts\|TestDevelopmentCheck'` |
|
||||||
|
| Guarded release publication and recovery | [Publication regression](../release_publish_test.go) | `go test . -run '^TestReleasePublication'` |
|
||||||
|
|
||||||
## Fuzz validation
|
## Fuzz validation
|
||||||
|
|
||||||
|
|||||||
@@ -137,9 +137,11 @@ permission failures, explicit `conf.d` use, and entry/candidate budgets. This wo
|
|||||||
has no Narratio production equivalent; it uses the selected standard-library
|
has no Narratio production equivalent; it uses the selected standard-library
|
||||||
`path.Match` and bounded `File.ReadDir` adaptation rather than its flat loader.
|
`path.Match` and bounded `File.ReadDir` adaptation rather than its flat loader.
|
||||||
|
|
||||||
### Profiles and overlay
|
### Upstream profiles and ConfigKit selected overlays
|
||||||
|
|
||||||
Assigned to selected-profile overlay:
|
The following upstream symbols and case names retain their original profile
|
||||||
|
terminology. ConfigKit adapts their selected-overlay behavior without renaming the
|
||||||
|
upstream evidence:
|
||||||
|
|
||||||
- Production: `mergeOverlayComposition`, `mergeOverlayNodes`,
|
- Production: `mergeOverlayComposition`, `mergeOverlayNodes`,
|
||||||
`selectPipelineProfile`, `loadPipelineProfileOverlays`, and
|
`selectPipelineProfile`, `loadPipelineProfileOverlays`, and
|
||||||
@@ -153,19 +155,21 @@ Assigned to selected-profile overlay:
|
|||||||
`TestLoadPipelineProfilePairResolvesIndependentEffectivePipelines`.
|
`TestLoadPipelineProfilePairResolvesIndependentEffectivePipelines`.
|
||||||
- Preserve: recursive mapping overlay, atomic scalar/sequence replacement,
|
- Preserve: recursive mapping overlay, atomic scalar/sequence replacement,
|
||||||
deterministic selection failures, source ownership, and independent results.
|
deterministic selection failures, source ownership, and independent results.
|
||||||
- Adapt: load only the selected fixed profile path; lowercase `default` means no
|
- Adapt: load only the selected fixed overlay path; lowercase `default` means no
|
||||||
overlay. ConfigKit permits null and cross-kind replacement and does not support
|
selection. ConfigKit permits null and cross-kind replacement and does not support
|
||||||
declared defaults, inheritance, arbitrary profile paths, or validating every
|
declared defaults, inheritance, arbitrary overlay paths, or validating every
|
||||||
unselected overlay.
|
unselected overlay.
|
||||||
|
|
||||||
Implementation record (2026-09-06): `overlayDocuments`, `mergeOverlayMappings`,
|
Implementation record (2026-09-06, updated 2026-09-23): `overlayDocuments`,
|
||||||
`loadProfileDocument`, and `profileDirectiveDiagnostics` adapt the assigned merge,
|
`mergeOverlayMappings`, `loadSelectedOverlayDocument`, and
|
||||||
selection, loading, and ownership mechanics. `TestOverlayDocumentsRecursesMappingsAndReplacesAtomicSubtrees`,
|
`overlayDirectiveDiagnostics` adapt the assigned merge, selection, loading, and
|
||||||
`TestLoadAppliesSelectedProfileAfterBaseAndBeforeDefaults`, profile selection/error,
|
ownership mechanics. `TestOverlayDocumentsRecursesMappingsAndReplacesAtomicSubtrees`,
|
||||||
directive/version, containment, and budget cases adapt the assigned tests. ConfigKit
|
`TestLoadAppliesSelectedOverlayAfterBaseAndBeforeDefaults`, selected-overlay
|
||||||
|
selection/error, directive/version, containment, and budget cases adapt the assigned
|
||||||
|
tests. ConfigKit
|
||||||
uses exactly one fixed selected `.yml` source, permits null and cross-kind replacement,
|
uses exactly one fixed selected `.yml` source, permits null and cross-kind replacement,
|
||||||
retains displaced descendant history, rejects any profile directive or version-path
|
retains displaced descendant history, rejects any overlay directive or version-path
|
||||||
contribution, and counts the profile in aggregate budgets. Narratio's declared
|
contribution, and counts the overlay in aggregate budgets. Narratio's declared
|
||||||
default, multi-overlay validation, inheritance-like application conventions, and
|
default, multi-overlay validation, inheritance-like application conventions, and
|
||||||
null/kind restrictions were not retained.
|
null/kind restrictions were not retained.
|
||||||
|
|
||||||
@@ -196,7 +200,7 @@ previously extracted source claims, overlay displacement records, typed baseline
|
|||||||
and audited resolution snapshots in `load_metadata.go`. The representative
|
and audited resolution snapshots in `load_metadata.go`. The representative
|
||||||
`TestLayeredProvenanceAgreesWithResolvedSnapshot` adapts Narratio's stable ownership,
|
`TestLayeredProvenanceAgreesWithResolvedSnapshot` adapts Narratio's stable ownership,
|
||||||
profile ownership, deterministic effective projection, and side-effect-free
|
profile ownership, deterministic effective projection, and side-effect-free
|
||||||
inspection cases across one default/import/profile/resolution workflow. ConfigKit
|
inspection cases across one default/import/overlay/resolution workflow. ConfigKit
|
||||||
adds chronological descendant history for parent and whole-sequence operations,
|
adds chronological descendant history for parent and whole-sequence operations,
|
||||||
composite empty-mapping origins, canonical resolution reasons/dependencies, private
|
composite empty-mapping origins, canonical resolution reasons/dependencies, private
|
||||||
snapshot agreement, defensive nested copies, and concurrent load isolation. Value
|
snapshot agreement, defensive nested copies, and concurrent load isolation. Value
|
||||||
|
|||||||
38
docs/oss/attribution.md
Normal file
38
docs/oss/attribution.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Open Source Attribution Notices
|
||||||
|
|
||||||
|
## Standard Repository Policies
|
||||||
|
|
||||||
|
Material: `docs/policy/meta.md`, `docs/policy/oss.md`,
|
||||||
|
`docs/policy/documentation.md`, `docs/policy/agents.md`,
|
||||||
|
`docs/policy/architecture.md`, `docs/policy/testing.md`, and
|
||||||
|
`docs/policy/release.md`; root `AGENTS.md`; and the Policy Reading Guide in
|
||||||
|
`docs/development.md`, adapted for this repository.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/COPYRIGHT) |
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843).
|
||||||
|
|
||||||
|
## go-yaml v4
|
||||||
|
|
||||||
|
Selected module: `go.yaml.in/yaml/v4` at `v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
Copyright 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2025 The go-yaml Project Contributors
|
||||||
|
|
||||||
|
Copyright 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0 AND MIT
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[MIT](licenses/MIT.txt) |
|
||||||
|
[NOTICE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/NOTICE) |
|
||||||
|
[LICENSE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/yaml/go-yaml/tree/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125).
|
||||||
202
docs/oss/licenses/Apache-2.0.txt
Normal file
202
docs/oss/licenses/Apache-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
Creative Commons Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||||
|
|
||||||
|
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||||
|
|
||||||
|
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||||
|
|
||||||
|
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
18
docs/oss/licenses/MIT.txt
Normal file
18
docs/oss/licenses/MIT.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
||||||
|
following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||||
|
portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
||||||
|
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||||
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
91
docs/policy/agents.md
Normal file
91
docs/policy/agents.md
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
# Agent Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/agents.md)
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Agents must read and follow these rules.
|
||||||
|
|
||||||
|
## Implementation Discipline
|
||||||
|
|
||||||
|
**KEY PRINCIPLES:** Write the simplest idiomatic code that satisfies the user's
|
||||||
|
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
||||||
|
beyond what the user actually requested.
|
||||||
|
|
||||||
|
**Keep implementation machinery proportionate.** Use straightforward,
|
||||||
|
idiomatic code and introduce only the machinery needed to support the requested
|
||||||
|
behavior and flexibility. Optimize for conceptual simplicity and
|
||||||
|
maintainability, not for the fewest lines, fewest options, or narrowest product
|
||||||
|
surface.
|
||||||
|
|
||||||
|
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
||||||
|
harden, or otherwise narrow behavior unless required by the user, an explicit
|
||||||
|
repository contract, or an unavoidable correctness constraint. Preserve
|
||||||
|
operator and caller choice where policy has not been established. If an
|
||||||
|
additional restriction appears advisable, present it as a decision rather than
|
||||||
|
silently implementing it.
|
||||||
|
|
||||||
|
A correctness constraint must follow from the requested behavior or an
|
||||||
|
established invariant, not from the convenience of the chosen implementation.
|
||||||
|
Explain the specific failure it prevents and why a less restrictive
|
||||||
|
implementation cannot satisfy the contract.
|
||||||
|
|
||||||
|
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
||||||
|
or invariants beyond those expressly requested by the user.
|
||||||
|
|
||||||
|
**Use the standard library.** For example: in almost every case, the best
|
||||||
|
approach to copying files is to use the standard library. Writing custom code to
|
||||||
|
implement power-loss protection at the application level, or to guard against
|
||||||
|
bad actors with privileged and concurrent access to the host's filesystem,
|
||||||
|
is wasteful, unnecessary, and not idiomatic. Stick to the simple, standard, and
|
||||||
|
idiomatic approach unless another path is expressly requested by the user.
|
||||||
|
|
||||||
|
**An implementation detail is not repository policy.** Tests and documentation
|
||||||
|
must not elevate incidental behavior into a durable guarantee or restriction
|
||||||
|
unless that behavior was expressly selected as part of the contract. Existing
|
||||||
|
explicit contracts remain authoritative; changing or weakening one requires a
|
||||||
|
deliberate decision rather than being inferred from this principle.
|
||||||
|
|
||||||
|
Agent-authored plans, tests, documentation, and prior implementations are not
|
||||||
|
evidence that an additional restriction was deliberately approved. Identify the
|
||||||
|
authorizing requirement or decision; when that authority is unclear, surface
|
||||||
|
the ambiguity rather than treating repetition as approval.
|
||||||
|
|
||||||
|
## Git Commit Policy
|
||||||
|
|
||||||
|
By default, commit each completed, nonempty unit of work using a
|
||||||
|
concise, plain-English message describing what changed. This policy is standing
|
||||||
|
authorization to create those local commits; a separate user request is not
|
||||||
|
required. An explicit user instruction to leave work uncommitted takes precedence.
|
||||||
|
|
||||||
|
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
||||||
|
documentation.
|
||||||
|
Complete the appropriate validation before committing. If work is incomplete or
|
||||||
|
validation is blocked, report that state accurately.
|
||||||
|
|
||||||
|
Before committing:
|
||||||
|
|
||||||
|
1. Run `git status --short` and review the relevant diff, including any staged
|
||||||
|
changes. Identify changes that predate the current unit of work.
|
||||||
|
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
||||||
|
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
||||||
|
only when every included change belongs to that unit. Preserve unrelated
|
||||||
|
staged and unstaged work.
|
||||||
|
4. Review `git diff --staged` and run appropriate checks for the change. Reuse
|
||||||
|
successful checks for unchanged content.
|
||||||
|
5. Review `git log --oneline -n 10` and use
|
||||||
|
`git commit -m "<concise plain-English commit message>"`.
|
||||||
|
6. Report the commit identifier and any remaining uncommitted work.
|
||||||
|
|
||||||
|
If the unit cannot be safely separated from pre-existing work, leave it uncommitted
|
||||||
|
and explain the overlap rather than silently including that work. If a commit
|
||||||
|
fails, preserve the changes and report the failure; do not bypass hooks.
|
||||||
|
|
||||||
|
Default commit authorization does not authorize pushing, publishing, amending,
|
||||||
|
resetting, reverting, or rewriting history. Those actions require a separate user
|
||||||
|
instruction. Do not use `git commit -a` or `git commit --no-verify` to bypass the
|
||||||
|
staging and validation discipline above.
|
||||||
@@ -1,18 +1,38 @@
|
|||||||
# Architecture Policy
|
# Architecture Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
## Purpose and applicability
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/architecture.md)
|
||||||
|
|
||||||
|
## Purpose And Ownership
|
||||||
|
|
||||||
|
The adopted policy defines the application's purpose and the architectural
|
||||||
|
constraints contributors must follow. It owns system boundaries, responsibility
|
||||||
|
and dependency rules, established invariants, and explicit non-goals.
|
||||||
|
|
||||||
|
Describe the concrete package inventory and implementation mechanics in internal
|
||||||
|
documentation. Link to canonical public contracts for their exact behavior and
|
||||||
|
to ADRs for decision rationale.
|
||||||
|
|
||||||
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
||||||
and resolution across consuming applications. This policy governs contributions.
|
and resolution across consuming applications. The [component overview](../internal/overview.md)
|
||||||
The [component overview](../internal/overview.md) owns implementation inventory, the
|
owns implementation inventory, the [configuration contract](../config.md) owns
|
||||||
[configuration contract](../config.md) owns implemented behavior, and the
|
implemented behavior, and the [deferred scope](../roadmap/deferred.md) preserves
|
||||||
[deferred scope](../roadmap/deferred.md) preserves deferred scope.
|
deferred scope.
|
||||||
|
|
||||||
## Success criteria
|
## Adopted Constraints And Implemented Structure
|
||||||
|
|
||||||
|
Architectural constraints govern current and future development. Record
|
||||||
|
implemented structure accurately, proposals and implementation status in the
|
||||||
|
roadmap, and significant decisions and rationale in ADRs. Describe a target
|
||||||
|
structure as implemented when its changes land.
|
||||||
|
|
||||||
|
Constraints must reflect deliberately selected requirements and decisions.
|
||||||
|
Do not promote incidental implementation choices into architectural invariants.
|
||||||
|
|
||||||
|
## Success Criteria
|
||||||
|
|
||||||
1. **Reduce application infrastructure:** Can applications delete substantial
|
1. **Reduce application infrastructure:** Can applications delete substantial
|
||||||
configuration infrastructure while retaining clear ownership of their domain
|
configuration infrastructure while retaining clear ownership of their domain
|
||||||
@@ -51,7 +71,7 @@ boundaries, and keep simple consumers independent of optional composition
|
|||||||
features. The [consumer adoption guide](../consumers/README.md) demonstrates the
|
features. The [consumer adoption guide](../consumers/README.md) demonstrates the
|
||||||
implemented surface against representative simple and complex shapes.
|
implemented surface against representative simple and complex shapes.
|
||||||
|
|
||||||
## Responsibility boundaries
|
## Responsibility Boundaries
|
||||||
|
|
||||||
ConfigKit owns configuration input processing and the coordination of decoding,
|
ConfigKit owns configuration input processing and the coordination of decoding,
|
||||||
resolution, validation, and inspection. Applications own their configuration
|
resolution, validation, and inspection. Applications own their configuration
|
||||||
@@ -68,10 +88,10 @@ must never run implicitly as part of configuration loading.
|
|||||||
Remote data can enter through application-supplied input without introducing a
|
Remote data can enter through application-supplied input without introducing a
|
||||||
network provider into the library.
|
network provider into the library.
|
||||||
|
|
||||||
## Public API and dependency direction
|
## Public API And Dependency Direction
|
||||||
|
|
||||||
Keep one small, coherent public surface for the supported lifecycle. Simple
|
Keep one small, coherent public surface for the supported lifecycle. Simple
|
||||||
single-document consumers must not need import, profile, or provider machinery.
|
single-document consumers must not need import, overlay, or provider machinery.
|
||||||
Do not expose parser-specific nodes, errors, or extension hooks through the
|
Do not expose parser-specific nodes, errors, or extension hooks through the
|
||||||
public API. Parser integration belongs behind a private boundary, as recorded
|
public API. Parser integration belongs behind a private boundary, as recorded
|
||||||
in [ADR 0002](../adr/0002-own-yaml-semantics.md).
|
in [ADR 0002](../adr/0002-own-yaml-semantics.md).
|
||||||
@@ -94,7 +114,7 @@ Dependencies must preserve those boundaries; package splits and abstractions
|
|||||||
must earn their complexity. Do not impose a full application or hexagonal
|
must earn their complexity. Do not impose a full application or hexagonal
|
||||||
framework on this library.
|
framework on this library.
|
||||||
|
|
||||||
## Configuration integrity
|
## Configuration Integrity
|
||||||
|
|
||||||
Composition and intentional overlay are distinct operations. Composition must
|
Composition and intentional overlay are distinct operations. Composition must
|
||||||
not silently become last-wins override through file ordering. The decision and
|
not silently become last-wins override through file ordering. The decision and
|
||||||
@@ -106,7 +126,7 @@ same inputs and options. Invalid input must not produce a successful usable
|
|||||||
configuration. Do not run application hooks on invalid typed configuration.
|
configuration. Do not run application hooks on invalid typed configuration.
|
||||||
|
|
||||||
User-controlled precedence is application defaults, composed base, selected
|
User-controlled precedence is application defaults, composed base, selected
|
||||||
profile, then explicitly supplied CLI overrides. Applications own flag parsing;
|
overlay, then explicitly supplied CLI overrides. Applications own flag parsing;
|
||||||
ConfigKit owns overlay semantics and provenance. Domain resolution follows these
|
ConfigKit owns overlay semantics and provenance. Domain resolution follows these
|
||||||
inputs and must remain recorded, not become a hidden override channel.
|
inputs and must remain recorded, not become a hidden override channel.
|
||||||
|
|
||||||
@@ -122,7 +142,7 @@ See [ADR 0005](../adr/0005-explicit-overrides-and-safe-explanation.md).
|
|||||||
Detailed syntax and operation tables belong to the
|
Detailed syntax and operation tables belong to the
|
||||||
[current configuration contract](../config.md).
|
[current configuration contract](../config.md).
|
||||||
|
|
||||||
## Ownership and confidentiality
|
## Ownership And Confidentiality
|
||||||
|
|
||||||
Returned configuration and metadata must not share mutable state across loads.
|
Returned configuration and metadata must not share mutable state across loads.
|
||||||
ConfigKit must not mutate a result after returning it. Ordinary exported Go
|
ConfigKit must not mutate a result after returning it. Ordinary exported Go
|
||||||
@@ -143,7 +163,7 @@ forwarded blindly when they can include raw input. Do not log configuration
|
|||||||
implicitly. Applications remain responsible for classifying their secrets and
|
implicitly. Applications remain responsible for classifying their secrets and
|
||||||
for safe messages supplied by their hooks.
|
for safe messages supplied by their hooks.
|
||||||
|
|
||||||
## Scope boundaries
|
## Scope Boundaries
|
||||||
|
|
||||||
Do not introduce automatic directory discovery, network providers, arbitrary
|
Do not introduce automatic directory discovery, network providers, arbitrary
|
||||||
merge strategies, additional configuration languages, or application runtime
|
merge strategies, additional configuration languages, or application runtime
|
||||||
|
|||||||
@@ -1,125 +1,176 @@
|
|||||||
# Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.11
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/documentation.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Assign each documentation topic one canonical owner so ConfigKit's documentation
|
This policy assigns each documentation topic to one canonical owner. Its goal is
|
||||||
remains accurate and useful to consumers, maintainers, and implementation agents.
|
to keep ConfigKit's documentation accurate, concise, discoverable, and resistant
|
||||||
|
to drift for consumers, maintainers, developers, and coding agents.
|
||||||
|
|
||||||
## Core rules
|
## Core Rules
|
||||||
|
|
||||||
### One canonical owner
|
### One Canonical Owner
|
||||||
|
|
||||||
Each authoritative fact belongs in one owning document or Go declaration's
|
Each authoritative fact belongs in one document. A non-owning document may give
|
||||||
reference documentation. Other documents may summarize and link to that owner;
|
a short, stable summary for orientation, but it must link to the canonical owner
|
||||||
they must not maintain competing definitions of commands, API contracts, YAML
|
for volatile details.
|
||||||
semantics, defaults, paths, diagnostics, or compatibility guarantees.
|
|
||||||
|
|
||||||
### Policies, current behavior, and future work
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
|
module keys, schemas, file names, paths, status codes, retry behavior, and
|
||||||
|
runtime guarantees. If readers could reasonably treat a statement as a
|
||||||
|
contract, maintain it only in the owning document.
|
||||||
|
|
||||||
- Policies state currently binding contributor rules, including constraints on
|
### Current And Future Behavior
|
||||||
future implementation. They do not imply that features already exist.
|
|
||||||
- Current API/configuration contracts, consumer guidance, and component
|
|
||||||
documentation describe implemented behavior only, including partial boundaries.
|
|
||||||
- ADRs record accepted decisions and rationale. Acceptance is not evidence of
|
|
||||||
implementation; execution status belongs in roadmaps.
|
|
||||||
- Roadmaps own unimplemented targets, deferred work, and execution status.
|
|
||||||
|
|
||||||
Future implementation plans own their task order, acceptance gates, and progress;
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
`docs/roadmap/deferred.md` owns deliberate exclusions, not execution instructions.
|
Partial features may be described only to their implemented boundary.
|
||||||
As behavior lands, move its normative definition into the current contract and
|
|
||||||
replace the roadmap definition with a link. Retire completed roadmap material
|
|
||||||
as part of release preparation; ADRs preserve significant decision history.
|
|
||||||
|
|
||||||
### Audience and examples
|
Architectural constraints may govern future changes. Describe current structure
|
||||||
|
from implemented behavior.
|
||||||
|
|
||||||
Consumer documentation explains how to use the library and what consumers own.
|
ADRs may record an accepted architectural decision before implementation. The
|
||||||
Internal documents explain mechanisms and dependencies. Keep implementation
|
roadmap owns implementation status and sequencing until the decision is
|
||||||
mechanics out of consumer guidance unless they affect a meaningful choice.
|
implemented. Current architecture, user, operator, integration, and internal
|
||||||
|
documentation are updated when the behavior lands.
|
||||||
|
|
||||||
Complete copyable artifacts belong in `examples/`; Go API examples may live in
|
`docs/roadmap/deferred.md` owns deliberate exclusions; task-specific plans
|
||||||
executable Go example tests beside the relevant package. Prose should use the
|
own execution order and progress. Completed plans retire during release
|
||||||
smallest useful excerpt and link to the maintained artifact. Examples must be
|
preparation.
|
||||||
secret-free and checked against implemented behavior. Clearly label illustrative
|
|
||||||
future syntax in roadmaps; do not present it as a runnable current example.
|
|
||||||
|
|
||||||
### Security and privacy
|
### Audience And Detail
|
||||||
|
|
||||||
Do not include real credentials, private keys, environment dumps, sensitive input,
|
Write for the document's stated audience and include only the detail needed for
|
||||||
or private infrastructure details unless intentionally public. Document secret
|
its owned topic. Keep user and operator docs focused on using and operating the
|
||||||
handling, not secret values.
|
application. Developer docs should link to user-facing and external contracts
|
||||||
|
for their definitions.
|
||||||
|
|
||||||
## Canonical ownership
|
### Examples
|
||||||
|
|
||||||
| Topic | Owner | Boundary |
|
Complete copyable files belong in `examples/`. Documentation may use the
|
||||||
| --- | --- | --- |
|
smallest illustrative snippet needed to explain its owned topic, but should link
|
||||||
| Product orientation | `README.md` | Current status, purpose, navigation, and a minimal working example |
|
to maintained examples for complete copyable files.
|
||||||
| Contributor entry point | `docs/development.md` | Reading guide and actual baseline validation commands |
|
|
||||||
| Architecture rules | `docs/policy/architecture.md` | Responsibilities, dependency constraints, invariants, and scope boundaries |
|
|
||||||
| Documentation rules | `docs/policy/documentation.md` | Ownership and document lifecycle |
|
|
||||||
| Testing rules | `docs/policy/testing.md` | Risk-based sufficiency, test boundaries, and maintenance principles |
|
|
||||||
| Release rules | `docs/policy/release.md` | Compatibility, integrity, gates, immutability, and exceptions |
|
|
||||||
| Release procedure | `docs/release.md` | Exact maintainer commands, prerequisites, supported targets, and verification |
|
|
||||||
| Exported Go API | Go documentation beside declarations | Symbol contracts, errors, ownership, and lifecycle API behavior |
|
|
||||||
| YAML and resolution semantics | `docs/config.md` | Syntax, composition, precedence, conversion, secret references/bootstrap, and explanation semantics; Go reference docs link here for shared rules |
|
|
||||||
| Consumer walkthroughs | `docs/consumers/`, when useful | Task-oriented usage and consumer responsibilities, not duplicate API reference |
|
|
||||||
| Component inventory | `docs/internal/overview.md` | Implemented components and links to their owners |
|
|
||||||
| Component mechanics | Other `docs/internal/` files, when needed | Detailed implementation behavior and change recipes |
|
|
||||||
| Architectural decisions | `docs/adr/` | Context, decisions, alternatives, consequences, and supersession history |
|
|
||||||
| Deferred scope | `docs/roadmap/deferred.md` | Deliberate exclusions and the conditions for reconsidering them |
|
|
||||||
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, task order, acceptance gates, and progress; completed plans retire to Git history |
|
|
||||||
| Historical release notes | `docs/releases/` | Version-specific historical summaries required by release policy |
|
|
||||||
| Complete examples | `examples/` and executable Go examples | Maintained artifacts; prose links instead of duplicating full examples |
|
|
||||||
|
|
||||||
A listed owner is not a requirement to create an empty file before it has useful
|
Executable Go API examples may live beside the relevant package.
|
||||||
content. Create API, consumer, example, and component documents when the corresponding behavior
|
|
||||||
exists and there is useful content to own. Link only to existing files; use plain
|
|
||||||
code paths for planned files. Unvalidated candidate and publication work has the
|
|
||||||
explicit temporary exception recorded in the release policy.
|
|
||||||
|
|
||||||
ConfigKit has no owned HTTP service, application CLI, or runtime operations
|
Examples must be valid, secret-free, and tested where practical. Commands and
|
||||||
interface. Do not create those reference documents for consuming applications.
|
configuration used in documentation should match the application.
|
||||||
|
|
||||||
## Boundary rules
|
### Security And Privacy
|
||||||
|
|
||||||
Architecture owns governing constraints; ADRs explain why; contracts describe
|
Documentation and examples must not contain real credentials, private keys,
|
||||||
implemented semantics; internal documentation explains how. A roadmap may link
|
private environment dumps, sensitive source material, or private infrastructure
|
||||||
to all of them but must not become a second current reference.
|
details unless intentionally public. Document secret-handling mechanisms, not
|
||||||
|
secret values.
|
||||||
|
|
||||||
Release policy owns guarantees; the release procedure owns commands. A release
|
## Canonical Ownership
|
||||||
note cannot redefine a compatibility contract or replace a current-documentation
|
|
||||||
update. The note at an immutable tag is that release's historical record.
|
|
||||||
|
|
||||||
This policy owns what documentation may disclose. Architecture owns security
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
invariants. Current configuration and Go API contracts own secret-classification
|
| --- | --- | --- | --- |
|
||||||
and rendering behavior when implemented; internal docs own their mechanisms.
|
| Product orientation and minimal example | `README.md` | Purpose, current status, shortest useful Go example, and navigation, including licensing and attribution. | Full Go API and configuration contracts, release procedure, and implementation detail. |
|
||||||
|
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, contributor orientation, baseline validation commands, and canonical links. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
|
||||||
|
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
||||||
|
| Policy-set provenance and upstream navigation | `docs/policy/meta.md` | Policy-set origin, local authority, adoption baselines, and upstream adoption and update links. | Task-specific reading triggers, detailed adoption procedures, and formal attribution notices. |
|
||||||
|
| Agent policy | `docs/policy/agents.md` | Proportionate, idiomatic implementation; rules against inventing requirements, restrictions, guarantees, or policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
||||||
|
| Documentation policy | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
||||||
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk sufficiency, boundaries, doubles, coverage, regressions, and test maintenance. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
|
| Release policy | `docs/policy/release.md` | Versioning, compatibility, release integrity and immutability, release documentation, proportionate gates, publication controls, completion, and required versus optional checks. | Repository-specific commands, product installation guidance, CLI version semantics, historical release summaries, and CI implementation detail. |
|
||||||
|
| Open source licensing and attribution policy | `docs/policy/oss.md` | License defaults and author choices, COPYRIGHT and attribution formats, license/notice links, discoverability, maintenance, and concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
|
||||||
|
| Project copyright and license grant | `COPYRIGHT` | Project identity, copyright holders and years, SPDX expression, code grant, separately licensed document scope, warranty disclaimer, and third-party statement. | Complete license texts and upstream component attribution. |
|
||||||
|
| Project license texts | `LICENSE` | Complete project and incorporated companion license texts, with required project-specific fields. | General licensing policy and upstream component attribution. |
|
||||||
|
| Upstream component attribution | `docs/oss/attribution.md` | House Format entries for dependencies and adapted documents: identity, material scope, copyright, license, notices, and source links. | General policy, exception reasoning, and complete standard license texts. |
|
||||||
|
| Standard license texts | `docs/oss/licenses/` | Complete, verbatim standard license texts shared by applicable entries, including copied documentation. | Project-specific upstream notices, attribution prose, and policy interpretation. |
|
||||||
|
| Repository-specific release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, validation and publication commands and automated guards, asynchronous deliverables, delivery status, optional consumer verification, and recovery. | General release requirements, product installation guidance, historical release summaries, and current compatibility contracts. |
|
||||||
|
| Exported Go API | Go documentation beside declarations | Symbol contracts, errors, ownership, and lifecycle behavior. | Shared YAML semantics and complete examples. |
|
||||||
|
| Configuration contract | `docs/config.md` | YAML syntax, composition, precedence, schema, defaults, resolution, validation, secrets, and explanation semantics. | Go symbol contracts, complete examples, and implementation detail. |
|
||||||
|
| Consumer guidance for the public Go API | `docs/consumers/` | Task-oriented public Go API usage, minimal examples, and consumer responsibilities. | Go symbol contracts, configuration semantics, and internal implementation detail. |
|
||||||
|
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
|
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
|
| Architectural decision records | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
||||||
|
| Deferred scope | `docs/roadmap/deferred.md` | Deliberate exclusions and conditions for reconsideration. | Task execution and current behavior. |
|
||||||
|
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, sequencing, acceptance, and progress; completed plans retire during release preparation. | Implemented behavior and ADR rationale. |
|
||||||
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
|
| Complete examples | `examples/` and executable Go examples | Maintained copyable artifacts and Go API examples. | Configuration reference, symbol contracts, and prose explanation. |
|
||||||
|
|
||||||
## Architectural decision records
|
Create supporting documents for existing interfaces and responsibilities when
|
||||||
|
substantive content is available.
|
||||||
|
|
||||||
Use sequential filenames, such as `0001-separate-composition-and-overlay.md`,
|
Do not create empty owners.
|
||||||
and the lightweight Nygard structure: title, status, date, context, decision,
|
|
||||||
alternatives considered, and consequences.
|
|
||||||
|
|
||||||
Accepted decision content is immutable. A changed decision requires a new ADR
|
## Boundary Rules
|
||||||
and a superseded status/link in the old one. Navigation links may be repaired
|
|
||||||
when specification ownership moves without rewriting historical rationale.
|
|
||||||
Rejected architectural alternatives belong in ADRs; deferred or rejected product
|
|
||||||
features belong in roadmaps. Do not create an ADR for every routine choice.
|
|
||||||
|
|
||||||
## Maintenance and verification
|
### Orientation
|
||||||
|
|
||||||
Update the owning current documentation in the same change that implements or
|
Link among orientation, architecture, and internal documents; maintain each
|
||||||
changes behavior. When ownership moves, remove the old definition and preserve
|
package or behavior description in its canonical owner.
|
||||||
useful navigation links.
|
|
||||||
|
### Go API And Configuration
|
||||||
|
|
||||||
|
Go declaration documentation owns exported symbol behavior. The configuration
|
||||||
|
contract owns shared YAML and resolution semantics. Consumer guidance explains
|
||||||
|
tasks and links to those contracts.
|
||||||
|
|
||||||
|
### Releases
|
||||||
|
|
||||||
|
The release policy defines requirements and invariants that every release must
|
||||||
|
satisfy. The repository-specific release procedure defines the commands and
|
||||||
|
workflow maintainers use to satisfy that policy. Release notes record history
|
||||||
|
at immutable tags. Maintain current behavior in its canonical documentation,
|
||||||
|
update it with the corresponding behavior changes, and keep release procedures
|
||||||
|
consistent with adopted policy.
|
||||||
|
|
||||||
|
### Project Licensing And Upstream Attribution
|
||||||
|
|
||||||
|
README and release documents link to the canonical licensing and attribution
|
||||||
|
materials under the [OSS policy](oss.md). The release procedure owns URL
|
||||||
|
construction and publication mechanics.
|
||||||
|
|
||||||
|
### Contracts And Implementation
|
||||||
|
|
||||||
|
Go API and configuration documents define externally observable behavior.
|
||||||
|
Internal documents explain implementation and link to the owning contract.
|
||||||
|
|
||||||
|
### Security Topics
|
||||||
|
|
||||||
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
|
application security invariants. The configuration and public API contracts own
|
||||||
|
secret-classification, bootstrap, and rendering behavior. Internal docs own
|
||||||
|
implementation mechanisms only.
|
||||||
|
|
||||||
|
## Architecture Decision Records
|
||||||
|
|
||||||
|
Use sequentially numbered ADR filenames such as
|
||||||
|
`0001-record-architecture-decisions.md`. Follow the lightweight Nygard format:
|
||||||
|
|
||||||
|
1. title;
|
||||||
|
2. status;
|
||||||
|
3. date;
|
||||||
|
4. context;
|
||||||
|
5. decision;
|
||||||
|
6. alternatives considered;
|
||||||
|
7. consequences.
|
||||||
|
|
||||||
|
Treat the decision content of an accepted ADR as immutable. When a decision
|
||||||
|
changes, create a new ADR and update the earlier ADR's status to superseded.
|
||||||
|
Rejected architectural alternatives belong in the ADR; rejected product ideas
|
||||||
|
belong in the roadmap. Routine choices need no ADR.
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
When behavior changes, update its canonical owner in the same change. If
|
||||||
|
ownership moves, remove the old definition and replace it with a link where
|
||||||
|
navigation remains useful.
|
||||||
|
|
||||||
Before completing documentation work:
|
Before completing documentation work:
|
||||||
|
|
||||||
- verify claims against the implementation or clearly identify future design;
|
- verify affected behavior and examples;
|
||||||
- check changed local links, paths, fragments, examples, and commands;
|
- check commands, flags, fields, defaults, schemas, and paths against their
|
||||||
- preserve the distinction between policy, decisions, target behavior, and status;
|
implementation;
|
||||||
- check canonical ownership and remove stale or duplicate definitions;
|
- keep unimplemented behavior in the roadmap, subject to the ADR exception;
|
||||||
- inspect formatting and whitespace;
|
- remove stale references and validate links;
|
||||||
- ensure no sensitive data was introduced.
|
- confirm that non-owning documents summarize and link rather than redefine;
|
||||||
|
- confirm that no secrets or sensitive private data were added.
|
||||||
|
|||||||
27
docs/policy/meta.md
Normal file
27
docs/policy/meta.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Policy Set Provenance
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.0
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/meta.md)
|
||||||
|
|
||||||
|
## Origin And Local Authority
|
||||||
|
|
||||||
|
This repository's policy set is adapted from
|
||||||
|
[Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy).
|
||||||
|
The adopted local policies govern work in this repository. Upstream revisions
|
||||||
|
become local policy through deliberate adoption, preserving local decisions.
|
||||||
|
Each policy's `Upstream Source` identifies its adopted baseline.
|
||||||
|
|
||||||
|
## Adoption And Updates
|
||||||
|
|
||||||
|
For policy adoption, upstream revision reviews, and updates, consult the
|
||||||
|
[upstream adoption and update guide](https://gitea.maximumdirect.net/eric/policy/src/branch/main/docs/adoption.md).
|
||||||
|
That guide and the reference example collection are maintained upstream and
|
||||||
|
accessed through links. Keep discovery links pointed at the current upstream
|
||||||
|
project and guide; keep adopted-source and example links pinned to commits.
|
||||||
|
|
||||||
|
The local [developer guide](../development.md) routes tasks to applicable
|
||||||
|
policies. Formal credit and licensing notices for the copied policy material
|
||||||
|
belong in the local [attribution document](../oss/attribution.md).
|
||||||
217
docs/policy/oss.md
Normal file
217
docs/policy/oss.md
Normal file
@@ -0,0 +1,217 @@
|
|||||||
|
# Open Source Licensing And Attribution Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.8
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md)
|
||||||
|
|
||||||
|
## ConfigKit Applicability
|
||||||
|
|
||||||
|
ConfigKit's selected grant is LGPL-3.0-or-later, recorded in
|
||||||
|
[COPYRIGHT](../../COPYRIGHT), with the complete LGPLv3 and incorporated GPLv3
|
||||||
|
texts in [LICENSE](../../LICENSE). The [release procedure](../release.md)
|
||||||
|
owns source-only Go module publication through Gitea. No separate hosted release
|
||||||
|
object or license asset is required for this channel.
|
||||||
|
|
||||||
|
## Purpose And Scope
|
||||||
|
|
||||||
|
This policy defines project licensing conventions and a repeatable House Format
|
||||||
|
for upstream attribution and license notices. It covers the project's own code
|
||||||
|
and upstream components incorporated into or distributed with the application
|
||||||
|
or library, including relevant transitive dependencies and copied code,
|
||||||
|
documentation, or assets.
|
||||||
|
Determine treatment from the component's terms and actual use.
|
||||||
|
|
||||||
|
Consulting development guidance or using tooling alone does not require an
|
||||||
|
attribution entry. Copying or adapting documentation for inclusion in the
|
||||||
|
repository is different: preserve its applicable attribution and license terms.
|
||||||
|
A material's role as development guidance does not exempt copied documents.
|
||||||
|
Apply any express permissions for attribution-free reuse of example formatting.
|
||||||
|
|
||||||
|
The baseline is a publicly available source repository with releases published
|
||||||
|
alongside it. The format is independent of language, forge, and build system.
|
||||||
|
It does not require attribution for every development tool, establish license
|
||||||
|
compatibility, or resolve every obligation arising from use or distribution.
|
||||||
|
|
||||||
|
## Canonical Locations
|
||||||
|
|
||||||
|
The [documentation policy](documentation.md) assigns ownership:
|
||||||
|
|
||||||
|
- `COPYRIGHT`: project name, copyright statements, SPDX expression, grant,
|
||||||
|
warranty disclaimer, and third-party statement.
|
||||||
|
- `LICENSE` contains the complete, unmodified project license text, including
|
||||||
|
incorporated companion text. Dependency attribution does not relicense the project.
|
||||||
|
- `docs/oss/attribution.md`: canonical component entries.
|
||||||
|
- `docs/oss/licenses/`: complete, verbatim standard and applicable companion texts.
|
||||||
|
|
||||||
|
Use recognizable license filenames, such as `Apache-2.0.txt` or `LGPL-3.0.txt`.
|
||||||
|
A shared standard text may serve multiple entries. Keep explanations outside
|
||||||
|
license texts and preserve distinct versions and exceptions.
|
||||||
|
|
||||||
|
## Upstream Reference Examples
|
||||||
|
|
||||||
|
Use the commit-pinned upstream examples to create actual project notices.
|
||||||
|
Retain their links and keep the example collection upstream; keep applicable
|
||||||
|
license texts locally as specified above. The
|
||||||
|
[standard license-text collection](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/oss/licenses/README.md)
|
||||||
|
identifies the available reference texts.
|
||||||
|
|
||||||
|
## Project Licensing
|
||||||
|
|
||||||
|
Unless the author specifies otherwise, use **GPL version 3 or later**
|
||||||
|
(`GPL-3.0-or-later`) for applications and **LGPL version 3 or later**
|
||||||
|
(`LGPL-3.0-or-later`) for libraries. An author's explicit choice takes precedence:
|
||||||
|
for example, a one-off script may use MIT. Such a choice requires no exception
|
||||||
|
rationale, additional approval, or compensating controls under this policy.
|
||||||
|
|
||||||
|
These defaults guide new license selection. Adopting this policy does not
|
||||||
|
relicense existing code or override third-party terms. Preserve an existing
|
||||||
|
license unless the author deliberately changes it. For mixed-purpose projects,
|
||||||
|
follow the author's selected scope rather than inferring different licenses for
|
||||||
|
individual packages.
|
||||||
|
|
||||||
|
Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/application/COPYRIGHT)
|
||||||
|
or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/library/COPYRIGHT)
|
||||||
|
to create the project’s root `COPYRIGHT` file.
|
||||||
|
Use verified project names, contribution years, and copyright holders.
|
||||||
|
For another selected license, adapt the grant, SPDX expression, disclaimer, and
|
||||||
|
text references together to reflect the author's selected grant.
|
||||||
|
|
||||||
|
For GPLv3 projects, copy the complete GPLv3 text into `LICENSE`. For LGPLv3
|
||||||
|
projects, place the complete LGPLv3 text followed by the complete GPLv3 text in
|
||||||
|
`LICENSE`; the LGPL incorporates the GPL terms. Keep the texts unmodified and
|
||||||
|
place project-specific statements in `COPYRIGHT`. For the default grants, the
|
||||||
|
grant and SPDX expression in `COPYRIGHT` must expressly identify `or-later`;
|
||||||
|
follow the author’s choice if a different grant is selected.
|
||||||
|
|
||||||
|
For other licenses, provide their complete text and any required project-specific
|
||||||
|
fields; the standard reference collection remains unchanged. Keep `COPYRIGHT`,
|
||||||
|
`LICENSE`, SPDX expressions, and README descriptions consistent with the actual
|
||||||
|
grant. This convention introduces no blanket requirement for per-file headers;
|
||||||
|
preserve notices or add them where the applicable terms require them.
|
||||||
|
|
||||||
|
Identify separately licensed documentation or assets in the project grant, with
|
||||||
|
links to their attribution and license information. An application's default
|
||||||
|
code license does not override the terms of incorporated documentation.
|
||||||
|
|
||||||
|
## Upstream Attribution House Format
|
||||||
|
|
||||||
|
Begin `docs/oss/attribution.md` with `# Open Source Attribution Notices`,
|
||||||
|
followed directly by component entries. These comprise the complete document.
|
||||||
|
|
||||||
|
Each entry presents these five fields in order, with blank lines between them:
|
||||||
|
|
||||||
|
1. **Project name** as a level-two heading. An optional identification paragraph
|
||||||
|
may follow, such as `Selected module: MODULE at VERSION.` with the module and
|
||||||
|
version in backticks. For copied documentation, a concise `Material:` sentence
|
||||||
|
may identify the affected files and whether they were adapted or copied
|
||||||
|
without modification. A factual qualifier such as `(transitive dependency)`
|
||||||
|
is permitted. Limit optional identification prose to factual component and
|
||||||
|
material scope.
|
||||||
|
2. **Upstream copyright statement or statements**, preserving their wording.
|
||||||
|
Put multiple statements in separate paragraphs. Include this field when the
|
||||||
|
selected upstream source supplies an applicable statement; otherwise, omit it.
|
||||||
|
3. **SPDX license identifier or expression**, when applicable, using
|
||||||
|
`SPDX-License-Identifier: EXPRESSION`.
|
||||||
|
4. **License and notice links**, beginning `License and notices:`, separated
|
||||||
|
by ` | `, and ending with a period. Label local standard texts by license
|
||||||
|
name, such as `MIT` or `Apache 2.0`. Label upstream files by their actual
|
||||||
|
filenames, such as `COPYRIGHT`, `LICENSE`, `NOTICE`, or `PATENTS`.
|
||||||
|
5. **Source repository link**, rendered exactly as `[Source](COMMIT_URL).`.
|
||||||
|
|
||||||
|
Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/attribution.md)
|
||||||
|
to create the project’s `docs/oss/attribution.md`.
|
||||||
|
The example illustrates omitted fields and multiple copyrights and licenses.
|
||||||
|
Replace the uppercase placeholders and illustrative URLs with actual component
|
||||||
|
information. Local license links are relative to the destination
|
||||||
|
`docs/oss/attribution.md`; copy the applicable texts into its `licenses/`
|
||||||
|
directory. Do not copy example entries for components the project does not use.
|
||||||
|
|
||||||
|
These are five fields, not a line limit. Omit the SPDX field when no applicable
|
||||||
|
identifier exists; identify nonstandard terms through the linked text. Preserve
|
||||||
|
licensing alternatives and exceptions, and record a selected option when
|
||||||
|
relevant through the factual license identification. Do not invent an identifier
|
||||||
|
or silently resolve an unsettled licensing choice.
|
||||||
|
|
||||||
|
Keep entries factual. Do not add agent-authored explanations of license
|
||||||
|
expressions, file-level license scope, research performed, retained source
|
||||||
|
notices, or compliance conclusions. Avoid filler such as "none is invented
|
||||||
|
here" and embellished link labels such as "upstream LICENSE", "additional
|
||||||
|
patent grant", or "at the imported commit". Preserve actual required upstream
|
||||||
|
content; this rule excludes editorial additions, not required notices. Policy
|
||||||
|
interpretation and exception reasoning belong in the adopted OSS policy or an
|
||||||
|
appropriate decision record, not the attribution document.
|
||||||
|
|
||||||
|
## License Texts And Upstream Links
|
||||||
|
|
||||||
|
Link standard license texts to their local copies. Link project-specific
|
||||||
|
notices to their upstream copies. Every upstream repository or notice link must
|
||||||
|
identify the exact commit corresponding to the
|
||||||
|
imported version, including the selected source revision for copied material.
|
||||||
|
|
||||||
|
Classify material according to its contents. An upstream `LICENSE`,
|
||||||
|
`COPYING`, or similar file may contain project-specific notices or exceptions
|
||||||
|
in addition to standard wording. Link both the local standard text and the
|
||||||
|
commit-specific upstream file when needed. Make companion license texts directly
|
||||||
|
reachable from the entry.
|
||||||
|
|
||||||
|
For project-specific license and attribution material, this policy accepts
|
||||||
|
direct links to the applicable upstream texts as satisfying reproduction,
|
||||||
|
inclusion, or copy requirements. This is the adopted house interpretation.
|
||||||
|
Agents must apply it without adding local-copy requirements or seeking repeated
|
||||||
|
approval solely because a license uses those terms.
|
||||||
|
|
||||||
|
This interpretation concerns notice reproduction. Concrete obligations such as
|
||||||
|
marking modified files or supplying corresponding source receive their own
|
||||||
|
applicable treatment. Preserve required notices already present in incorporated
|
||||||
|
source files; the central attribution entry does not authorize stripping them.
|
||||||
|
|
||||||
|
## Discoverability
|
||||||
|
|
||||||
|
End the project's README with two friendly statements linking to its actual
|
||||||
|
grant in `COPYRIGHT` and the attribution document. ConfigKit's
|
||||||
|
[README](../../README.md) contains the two required statements: one linking to
|
||||||
|
the project grant and one linking to attribution.
|
||||||
|
|
||||||
|
Each new checked-in release document and its hosted download page must end
|
||||||
|
with links whose visible text is `COPYRIGHT | LICENSE | ATTRIBUTION`. Use absolute
|
||||||
|
URLs to those files at the release's immutable tag or corresponding immutable source
|
||||||
|
revision so the links work in both locations. This release navigation is distinct
|
||||||
|
from upstream component links, which must use the imported commit.
|
||||||
|
|
||||||
|
Reuse the checked-in release document as the hosted release body where supported.
|
||||||
|
The release procedure owns concrete URLs and publication mechanics for delivering
|
||||||
|
the links through the selected channel. Do not maintain duplicate notice lists.
|
||||||
|
These conventions do not by themselves require separate downloadable license
|
||||||
|
assets, source bundles, or a different binary package format.
|
||||||
|
|
||||||
|
## Maintenance And Exceptions
|
||||||
|
|
||||||
|
Update project licensing statements together when the author changes the grant
|
||||||
|
or its scope. Update upstream notices in the change that adds, removes, upgrades,
|
||||||
|
copies, or changes the distribution of a relevant component. Check the selected source's license
|
||||||
|
and notices rather than assuming they are unchanged. Update affected entries,
|
||||||
|
commit links, and texts; retain historical versions through Git.
|
||||||
|
|
||||||
|
Check affected statements, faithful standard-text copies, and link destinations
|
||||||
|
as part of ordinary change review. For a future release tag, check intended file
|
||||||
|
paths against the candidate source; the tag need not resolve remotely before
|
||||||
|
publication. Do not add publication-time network checks, CI polling, recurring
|
||||||
|
legal sign-offs, mandatory scanners, or a full software bill of materials merely
|
||||||
|
to implement this policy.
|
||||||
|
|
||||||
|
Use the House Format routinely. Raise an exception only for a concrete obligation
|
||||||
|
or unresolved rights question it does not address, including any arising from a
|
||||||
|
particular distribution channel. Record the issue and selected treatment in the
|
||||||
|
adopted OSS policy or an appropriate decision record. Attribution entries
|
||||||
|
contain the resulting factual identification and required material, without
|
||||||
|
repeating that reasoning. Resolve the issue before the affected use or
|
||||||
|
distribution without reopening settled choices.
|
||||||
|
Common ownership of projects is neither required nor a blanket exception.
|
||||||
|
|
||||||
|
Apply the formatting convention prospectively. Do not rewrite published tags,
|
||||||
|
notes, binaries, or checksums to retrofit it. Address actual omissions deliberately
|
||||||
|
under the applicable terms and the [release correction policy](release.md#immutability-and-correction).
|
||||||
|
Ordinary attribution maintenance and release links are preparation work, not new
|
||||||
|
release approval gates.
|
||||||
@@ -1,41 +1,36 @@
|
|||||||
# Release Policy
|
# Release Policy
|
||||||
|
|
||||||
**Base Policy Version:** 0.1.0
|
**Base Policy Version:** 1.4
|
||||||
|
|
||||||
**Last Updated:** 2026-09-12
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/release.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This policy defines the minimum requirements for selecting, validating,
|
This policy defines a proportionate workflow for validating and publishing an
|
||||||
publishing, verifying, and correcting releases. Its goal is to make every
|
intended source revision under a fresh version. Releases should require little
|
||||||
release intentional, reproducible from an exact source revision, documented
|
routine intervention, avoid repeated work, and preserve published contents.
|
||||||
for consumers, and safe from retrospective replacement.
|
|
||||||
|
|
||||||
The repository-specific commands that implement these requirements belong in
|
The repository-specific commands belong in `docs/release.md`. Historical release
|
||||||
`docs/release.md`. Historical release summaries belong in `docs/releases/`.
|
summaries belong in `docs/releases/`. The procedure must agree with the adopted
|
||||||
Neither document may weaken this policy.
|
policy and link to it rather than introduce additional release requirements.
|
||||||
|
|
||||||
## ConfigKit applicability
|
## ConfigKit Applicability
|
||||||
|
|
||||||
ConfigKit adopts a source-only Go module release model. The source tag and
|
ConfigKit publishes a source-only Go module. Its declared deliverables are the
|
||||||
version-matched release note are the declared deliverables. Standalone binaries,
|
immutable annotated source tag and version-matched checked-in release note.
|
||||||
container images, and separate binary/package-registry publication are not
|
Standalone binaries, container images, hosted release objects, and separate
|
||||||
required. This does not waive source compilation, module hygiene, testing, or
|
registry publication are not required. Additional channels require a deliberate
|
||||||
consumer-facing module retrieval and build verification.
|
update to the policy and procedure.
|
||||||
|
|
||||||
The release procedure must define the module path, authoritative remote,
|
The Go API, documented YAML and resolution semantics, and structured diagnostic
|
||||||
supported Go versions and operating-system/architecture targets, prerequisite
|
contracts participate in compatibility review. A signature-preserving change
|
||||||
dependency acquisition, and the exact verification commands once established.
|
|
||||||
The default tests themselves remain deterministic and offline. Additional
|
|
||||||
publication channels require documented deliverables and verification before use.
|
|
||||||
|
|
||||||
The Go API, documented YAML/resolution semantics, and structured diagnostic
|
|
||||||
contracts all participate in compatibility review. A signature-preserving change
|
|
||||||
can still break consumers. Human diagnostic wording is stable only where a
|
can still break consumers. Human diagnostic wording is stable only where a
|
||||||
contract expressly promises it. Minimum Go version and platform support changes
|
contract expressly promises it. Minimum Go version and platform support
|
||||||
also require an explicit compatibility assessment.
|
changes also require an explicit compatibility assessment.
|
||||||
|
|
||||||
### Platform support
|
### Platform Support
|
||||||
|
|
||||||
Linux is the release-validated platform. macOS has best-effort support: keeping
|
Linux is the release-validated platform. macOS has best-effort support: keeping
|
||||||
it working remains desirable, but neither native macOS validation nor Darwin
|
it working remains desirable, but neither native macOS validation nor Darwin
|
||||||
@@ -44,44 +39,59 @@ does not by itself block a release. Voluntary checks and fixes are welcome; ther
|
|||||||
is no guarantee that each release has been validated on macOS.
|
is no guarantee that each release has been validated on macOS.
|
||||||
|
|
||||||
The [release procedure](../release.md#release-identity-and-support) owns target
|
The [release procedure](../release.md#release-identity-and-support) owns target
|
||||||
architectures and required Linux checks. This support change applies to upcoming
|
architectures and required Linux checks. Historical release notes and their
|
||||||
releases; historical release notes and their validation records remain unchanged.
|
validation records remain unchanged.
|
||||||
The v0.3.0 release note must explain the change in Compatibility, with version
|
|
||||||
selection following this policy's existing compatibility rules.
|
|
||||||
|
|
||||||
## Release Model
|
## Release Model And Completion
|
||||||
|
|
||||||
A release consists of:
|
A source release identifies one exact committed source revision through an
|
||||||
|
immutable version tag and a version-matched, checked-in release note. The
|
||||||
|
primary release branch is `main` unless the adopted policy specifies otherwise.
|
||||||
|
The procedure must name the authoritative publication remote.
|
||||||
|
|
||||||
- one exact source commit reachable from the repository's primary branch;
|
A successful push of the intended tag, with its source commit available on the
|
||||||
- one immutable version tag identifying that commit;
|
authoritative primary branch, completes the release. The source commit may be
|
||||||
- one version-matched, checked-in release note; and
|
pushed before the tag or published together with it through an atomic push.
|
||||||
- every artifact, image, package, registry entry, or other deliverable the
|
The procedure must choose and document the supported approach.
|
||||||
repository declares for that release.
|
|
||||||
|
|
||||||
The repository's primary branch is `main` unless an adopted policy documents
|
ConfigKit uses sequential explicit pushes: first the captured candidate to
|
||||||
an exception. A release candidate must be committed and pushed to that branch
|
authoritative `main`, then the annotated tag. Its
|
||||||
before its release tag is published.
|
[release procedure](../release.md) names `origin` and checks that its fetch and
|
||||||
|
push destinations resolve to the authoritative URL.
|
||||||
|
|
||||||
The source tag is the authoritative release identity. Published deliverables
|
Release commands must finish at successful publication. They must not wait for
|
||||||
must be traceable to the tagged source and must agree with its version. A
|
or poll CI, require successful CI status, inspect downloadable artifacts, or
|
||||||
repository may publish source only. When it publishes additional deliverables,
|
check consumer installation or Go module availability as completion gates.
|
||||||
its release procedure must enumerate them and define how each is built,
|
A failed or ambiguous push requires resolving the authoritative remote state
|
||||||
identified, published, and verified.
|
before declaring success or retrying; successful pushes do not require a
|
||||||
|
separate remote read-back gate.
|
||||||
|
|
||||||
Release automation may validate or publish a release only when its exact
|
Remote tag read-back and fresh consumer retrieval are optional and non-gating
|
||||||
responsibility is documented. Automation must not silently change the source
|
after successful publication. A failed push receives one bounded check of the
|
||||||
candidate, move a published tag, replace a published deliverable, or repair a
|
authoritative ref; do not poll or blindly retry.
|
||||||
release in place.
|
|
||||||
|
Repositories may publish source only. Additional binaries, images, packages,
|
||||||
|
checksums, or other declared deliverables may be published asynchronously from
|
||||||
|
the tagged source. The procedure must identify those deliverables and the
|
||||||
|
responsibility of their automation. Published deliverables must be traceable
|
||||||
|
to that source and identify the same version.
|
||||||
|
|
||||||
|
ConfigKit currently declares no additional deliverables. Its source-tag push
|
||||||
|
is the completion point.
|
||||||
|
|
||||||
## Versioning And Compatibility
|
## Versioning And Compatibility
|
||||||
|
|
||||||
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
||||||
no leading zeroes. Each version must be unused locally and in every configured
|
no leading zeroes. Prereleases require an explicit adopted policy defining
|
||||||
remote or publication channel before publication begins.
|
their format and use.
|
||||||
|
|
||||||
Unless an adopted policy explicitly supports and defines prereleases,
|
ConfigKit does not support prereleases.
|
||||||
prerelease versions are not permitted.
|
|
||||||
|
The selected version must be unused locally and on the authoritative remote.
|
||||||
|
Do not require queries to every configured remote or publication service.
|
||||||
|
A version known to have already been published must not be reused, even if the
|
||||||
|
normal guards do not inspect that channel. Adding a distribution channel
|
||||||
|
requires a deliberate update to the policy and procedure where needed.
|
||||||
|
|
||||||
For releases at or after `v1.0.0`:
|
For releases at or after `v1.0.0`:
|
||||||
|
|
||||||
@@ -94,146 +104,164 @@ configuration, data, integration, or compatibility contract when the release
|
|||||||
note explains the impact and required consumer action. A patch release must
|
note explains the impact and required consumer action. A patch release must
|
||||||
not intentionally break those contracts within its minor line.
|
not intentionally break those contracts within its minor line.
|
||||||
|
|
||||||
A repository with additional compatibility promises must define them in its
|
Additional compatibility promises and deliberate exceptions belong in the
|
||||||
adopted policy or canonical contract documentation. A release note may explain
|
adopted policy or canonical contract documentation. Release notes explain
|
||||||
a compatibility change, but it must not redefine the current compatibility
|
changes; they do not redefine current compatibility contracts.
|
||||||
contract.
|
|
||||||
|
|
||||||
## Release Documentation
|
## Release Documentation And Preparation
|
||||||
|
|
||||||
Every release made under this policy must include
|
Every new release must include `docs/releases/<version>.md` in the tagged
|
||||||
`docs/releases/<version>.md` in the tagged source tree. The filename must use
|
source tree. Use the complete version tag as the filename and begin with a
|
||||||
the complete version tag, and the document must begin with a title containing
|
title containing the product name and that exact version.
|
||||||
the product name and that exact version.
|
|
||||||
|
|
||||||
Every new release note must contain these sections:
|
ConfigKit requires the first line `# ConfigKit <version>`.
|
||||||
|
|
||||||
```markdown
|
Include a short summary and any relevant compatibility impact or upgrade
|
||||||
# <Product> vMAJOR.MINOR.PATCH
|
instructions. Choose sections suited to the release and keep the note
|
||||||
|
proportionate to the change.
|
||||||
|
|
||||||
This release ...
|
Keep exact current contracts in their canonical documents and update affected
|
||||||
|
documentation with the behavior change. Link to those documents from the note
|
||||||
|
where useful. If annotated tags are used, derive their summary from the
|
||||||
|
checked-in note.
|
||||||
|
|
||||||
## Summary
|
ConfigKit uses the complete checked-in note as the annotated tag message.
|
||||||
|
|
||||||
## Compatibility
|
Include the release footer defined by the [OSS policy](oss.md#discoverability)
|
||||||
|
in each new release document. The release procedure defines the concrete URLs
|
||||||
|
and publication mechanics. Prepare these links with the release note; they do
|
||||||
|
not add a network check or approval gate. If a hosted download page is used in
|
||||||
|
a future channel, preserve the footer there.
|
||||||
|
|
||||||
## Upgrade
|
Handle version selection, release-note content, and retirement of completed
|
||||||
|
roadmaps during preparation. Preserve planned and deferred work and repair
|
||||||
|
affected links when retiring roadmaps. Reuse ordinary change review for
|
||||||
|
unintended files, credentials, and private data. Scope release-content review
|
||||||
|
to the tagged source.
|
||||||
|
|
||||||
## Changes
|
## Candidate Validation
|
||||||
```
|
|
||||||
|
|
||||||
Use an explicit statement such as "No action required" when a section has no
|
Provide one publication command that validates the final committed candidate,
|
||||||
substantive content.
|
checks publication state, and publishes the intended refs. A validation-only
|
||||||
|
mode or command may be provided for diagnosis, but must not be a required step
|
||||||
|
before publication repeats the same checks.
|
||||||
|
|
||||||
Release notes are immutable historical summaries. They should link to current
|
ConfigKit uses `./scripts/release.sh vMAJOR.MINOR.PATCH`. The separate
|
||||||
canonical documentation for exact behavior. Every affected canonical document
|
`scripts/release-check.sh` remains an optional diagnostic command; the
|
||||||
must be updated in the same candidate; a release note must not substitute for
|
publication command invokes it once and does not use a persistent candidate
|
||||||
current documentation or defer required documentation changes.
|
record.
|
||||||
|
|
||||||
## Candidate Preparation And Validation
|
Run the complete deterministic, offline default test suite once for the final
|
||||||
|
candidate, following the [testing policy](testing.md). For repositories that
|
||||||
|
publish builds, verify the required build targets. Select those targets for
|
||||||
|
the application's actual support commitments; native testing on each platform
|
||||||
|
and access to particular hardware are not default release prerequisites.
|
||||||
|
|
||||||
Each repository must provide one documented release-check command or script
|
ConfigKit's one maintained Go 1.25 baseline runs the full suite with the race
|
||||||
that exercises the complete set of automated source-candidate gates. The
|
detector and test-time vet disabled. This protects library behavior, ownership,
|
||||||
repository-specific procedure must state all additional manual gates.
|
and concurrent use; the suite already includes examples, consumer fixtures,
|
||||||
|
documentation links, and package boundaries. One full vet pass adds static
|
||||||
|
checks beyond the test-time subset. CGO-disabled Linux amd64 and arm64 builds
|
||||||
|
cover supported configurations distinct from native race compilation. macOS
|
||||||
|
and newer-toolchain checks are optional.
|
||||||
|
|
||||||
The required gates are:
|
Additional gates must address a concrete risk that the existing checks do not
|
||||||
|
adequately cover. Do not automatically require linting, race testing, module
|
||||||
|
hygiene audits, documentation audits, credential scans, example validation, or
|
||||||
|
expanded platform matrices solely because they are possible. Retain such
|
||||||
|
checks when their distinct protection justifies their cost. A one-time migration
|
||||||
|
check must not silently become a permanent release requirement.
|
||||||
|
|
||||||
- dependency or module hygiene appropriate to the language and ecosystem;
|
The selected Go commands use readonly module mode with `GOPROXY=off`; acquire
|
||||||
- the complete deterministic, offline default test suite;
|
the baseline toolchain and dependencies before validation. Formatting and
|
||||||
- race, concurrency, or equivalent safety checks where the implementation can
|
whitespace remain ordinary development checks in `scripts/check.sh`.
|
||||||
be meaningfully checked for those risks;
|
Review module tidiness when dependencies change, not as a release gate.
|
||||||
- static analysis and linting used by the repository;
|
|
||||||
- production builds for every supported target that can be built in the
|
|
||||||
release environment;
|
|
||||||
- formatting and whitespace checks;
|
|
||||||
- validation of maintained examples, configuration, schemas, generated
|
|
||||||
sources, and documentation commands where applicable;
|
|
||||||
- review of changed local documentation links;
|
|
||||||
- removal of obsolete roadmap documents under `docs/roadmap/` that describe
|
|
||||||
completed work included in the release;
|
|
||||||
- review for unintended files, generated output, credentials, private data,
|
|
||||||
and unrelated changes; and
|
|
||||||
- any additional security, compatibility, migration, packaging, or platform
|
|
||||||
checks required by the product.
|
|
||||||
|
|
||||||
Unavailable tooling or an inapplicable check must be addressed explicitly in
|
Release tests must not require real credentials, mutable application services,
|
||||||
the adopted policy or release procedure; it must not disappear silently from
|
paid APIs, provider probes, or inference calls. The procedure may describe dependency
|
||||||
the candidate gates.
|
preparation separately from offline validation.
|
||||||
|
|
||||||
Run the complete checker while preparing the candidate. Commit the release
|
Avoid duplicate validation across release phases. Successful checks for the
|
||||||
note and all associated code, tests, documentation, and configuration, then
|
same final candidate need not be repeated solely to satisfy another phase;
|
||||||
run the complete checker again against the exact commit intended for release.
|
any reuse must clearly apply to that exact candidate. Persistent validation
|
||||||
Do not publish a release from uncommitted or unvalidated content.
|
caches are not required. If the candidate changes, validate the new candidate.
|
||||||
|
Cheap publication-state checks may be repeated immediately before pushing
|
||||||
|
because local or remote state may have changed during validation.
|
||||||
|
|
||||||
|
Automate mechanical guards. Human review gates are strongly disfavored: add one
|
||||||
|
only through an explicit project-specific policy decision explaining the
|
||||||
|
concrete risk and why ordinary change review or automation is insufficient.
|
||||||
|
Do not add routine confirmations for checks the command can perform itself.
|
||||||
|
|
||||||
|
Compatibility review, release-note accuracy, completed-roadmap retirement, and
|
||||||
|
review for unintended files or credentials remain ordinary preparation. The
|
||||||
|
executing agent may perform them without routine human approval or separate
|
||||||
|
manual evidence records. Publication itself requires authorization.
|
||||||
|
|
||||||
## Publication Guards
|
## Publication Guards
|
||||||
|
|
||||||
Immediately before publication, the maintainer or release automation must
|
Automate the checks needed to publish the intended source under a fresh version:
|
||||||
fetch the current primary branch and tags from the authoritative remote and
|
|
||||||
verify all of the following:
|
|
||||||
|
|
||||||
- the version has the required format and is not already published;
|
- the version has the adopted format and is unused locally and on the
|
||||||
- the current branch is the primary release branch;
|
authoritative remote;
|
||||||
- the worktree and index are clean;
|
- the worktree and index are clean on the primary release branch;
|
||||||
- the current commit is the recorded, validated candidate;
|
- the source being published is the exact candidate that passed validation,
|
||||||
- the authoritative remote branch points to that same commit;
|
including its matching release note;
|
||||||
- the matching release note exists in that commit and has the required title
|
- the remote primary branch can be advanced to that candidate without
|
||||||
and sections;
|
discarding remote history, and is published before the tag; and
|
||||||
- all required approvals and automated gates succeeded for that commit; and
|
- the tag identifies the validated candidate and only the intended refs are
|
||||||
- no local or remote tag already uses the selected version.
|
published.
|
||||||
|
|
||||||
Create the version tag against the guarded commit and verify its target before
|
ConfigKit also checks that `origin` has exactly the authoritative fetch and
|
||||||
publishing it. Publish only the exact intended ref and deliverables. Broad
|
push destination, including configured push URLs. The command checks the
|
||||||
operations such as `git push --tags` are discouraged because they can publish
|
candidate and unused version again after validation, and checks local state
|
||||||
unreviewed refs unrelated to the release.
|
before creating the tag. Ignored local files do not block publication.
|
||||||
|
|
||||||
The repository-specific procedure must make these guards executable or give
|
Fetch the authoritative branch and tag state as needed for these checks.
|
||||||
copyable commands for performing them.
|
Do not force branch or tag updates to bypass a failed guard. Publish explicit
|
||||||
|
refs rather than all local tags. Do not require CI success, publication-service
|
||||||
|
availability checks, or a separate manual confirmation for each guard.
|
||||||
|
|
||||||
## Immutability And Correction
|
## Immutability And Correction
|
||||||
|
|
||||||
Published version tags and published deliverables are immutable. Do not move,
|
Published version tags and published contents are immutable. Do not move,
|
||||||
overwrite, recreate, or delete a published tag. Do not replace an artifact,
|
overwrite, recreate, or delete a published tag, or replace a published artifact,
|
||||||
image, package, checksum, signature, provenance statement, or release note
|
checksum, signature, provenance statement, or release note under that version.
|
||||||
under an already published version.
|
The checked-in note at the immutable tag is that release's historical record.
|
||||||
|
|
||||||
If validation fails before publication, correct the candidate, rerun the
|
If validation fails before publication, correct and commit the candidate and
|
||||||
complete gates, and repeat the publication guards. An unpublished local tag
|
rerun the publication command. If a push fails or its outcome is ambiguous,
|
||||||
may be removed after confirming that it was never published or used by a
|
inspect the authoritative remote before retrying. Remove an unpublished local
|
||||||
release channel.
|
tag only after confirming it was never published or used by a release channel.
|
||||||
|
An unavailable remote leaves publication status unknown; do not overwrite a tag
|
||||||
|
to resolve uncertainty.
|
||||||
|
|
||||||
If publication or post-publication verification reveals a defect, leave the
|
Transient network, authentication, CI, or consumer-availability failures do not
|
||||||
published release intact. Correct the defect on the primary branch, choose a
|
by themselves require a new version.
|
||||||
new patch version or other semantically appropriate new version, write a new
|
|
||||||
matching release note, and perform the complete release procedure again.
|
|
||||||
|
|
||||||
A distribution channel's supported yank, deprecation, or advisory mechanism
|
A defect requiring changes to published source or contents requires a corrected
|
||||||
may warn consumers away from a defective release, but it must not replace that
|
commit, a new semantically appropriate version, a matching release note, and
|
||||||
release's contents or reuse its version.
|
the release procedure again. Leave the original release intact. A channel's
|
||||||
|
yank, deprecation, or advisory mechanism may warn consumers away from a defective
|
||||||
|
release without replacing its contents or reusing its version.
|
||||||
|
|
||||||
## Repository Release Procedure
|
## Repository Release Procedure
|
||||||
|
|
||||||
Every adopting repository must maintain `docs/release.md` as the canonical
|
Maintain `docs/release.md` as a short, executable maintainer runbook. It must
|
||||||
maintainer runbook for implementing this policy. It must define, in execution
|
identify prerequisites, the primary branch and authoritative remote, version
|
||||||
order:
|
and note preparation, one publication command with local checks and guards,
|
||||||
|
source-only deliverables, the successful-tag-push completion point, and
|
||||||
|
partial or unknown-state recovery.
|
||||||
|
|
||||||
1. maintainer prerequisites and required access;
|
Use copyable commands where practical. Keep optional diagnostics and consumer
|
||||||
2. version selection and compatibility review;
|
verification clearly optional. The procedure must not turn preparation work,
|
||||||
3. release-note creation;
|
ordinary change review, or post-publication investigation into additional
|
||||||
4. candidate preparation and the complete validation command;
|
release gates.
|
||||||
5. candidate commit, push, and exact commit recording;
|
|
||||||
6. publication guards;
|
|
||||||
7. exact tag and deliverable publication commands;
|
|
||||||
8. authoritative remote and consumer-facing verification; and
|
|
||||||
9. failure handling and correction.
|
|
||||||
|
|
||||||
The procedure should use copyable, fail-fast commands where practical. It must
|
|
||||||
name the primary branch, authoritative remote, tag form, published
|
|
||||||
deliverables, supported build targets, release automation responsibilities,
|
|
||||||
and consumer verification path. It must link to this policy instead of
|
|
||||||
restating or redefining its requirements.
|
|
||||||
|
|
||||||
## Policy Exceptions
|
## Policy Exceptions
|
||||||
|
|
||||||
|
The following historical exceptions do not change the current release workflow.
|
||||||
|
|
||||||
For v0.1.1 only, the maintainer approved renaming the reserved `_configkit` key to
|
For v0.1.1 only, the maintainer approved renaming the reserved `_configkit` key to
|
||||||
`configkit` as an error-correcting point release because there are no current
|
`configkit` as an error-correcting point release because there are no current
|
||||||
consumers. This intentionally changes the v0.1.0 configuration contract without a
|
consumers. This intentionally changes the v0.1.0 configuration contract without a
|
||||||
@@ -246,6 +274,3 @@ For v0.2.0 only, the maintainer accepted the successful native macOS check at
|
|||||||
only. The final candidate still requires the complete Linux release checker.
|
only. The final candidate still requires the complete Linux release checker.
|
||||||
This exception waives only repeating the macOS check after those documentation
|
This exception waives only repeating the macOS check after those documentation
|
||||||
changes; it does not waive other publication or verification gates.
|
changes; it does not waive other publication or verification gates.
|
||||||
|
|
||||||
Candidate selection, publication, and post-publication verification remain
|
|
||||||
mandatory steps in the [release procedure](../release.md).
|
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
# Testing Policy
|
# Testing Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/testing.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
||||||
|
|
||||||
We do not optimize for test count, line coverage, exhaustive isolation, or the fewest possible tests. We optimize for sufficient confidence in important behavior while imposing as little unnecessary friction as possible on future development.
|
We optimize for sufficient confidence in important behavior while minimizing friction on future development.
|
||||||
|
|
||||||
## ConfigKit-specific priorities
|
## ConfigKit-specific priorities
|
||||||
|
|
||||||
@@ -44,32 +46,19 @@ policy does not imply that those tools or tests already exist.
|
|||||||
|
|
||||||
## Every test has a cost
|
## Every test has a cost
|
||||||
|
|
||||||
Testing is not an unqualified good. Every test imposes both an immediate cost and a continuing lifetime cost.
|
Every test has an immediate and continuing cost: writing, review, execution,
|
||||||
|
diagnosis, fixture maintenance, and updates when legitimate behavior changes.
|
||||||
A test must be:
|
Tests can also constrain refactoring, duplicate policy, and add failure noise.
|
||||||
|
|
||||||
- written and reviewed;
|
|
||||||
- understood by future maintainers and coding agents;
|
|
||||||
- executed in local and CI workflows;
|
|
||||||
- diagnosed when it fails;
|
|
||||||
- updated when legitimate behavior changes;
|
|
||||||
- maintained as fixtures, APIs, and dependencies evolve; and
|
|
||||||
- removed or rewritten when it becomes redundant, brittle, misleading, or obsolete.
|
|
||||||
|
|
||||||
Tests also create cognitive and architectural friction. They can constrain refactoring, duplicate policy, slow feedback loops, add noise to failures, and cause harmless implementation changes to require unrelated edits across the suite.
|
|
||||||
|
|
||||||
A test is warranted only when the confidence it provides justifies these costs.
|
A test is warranted only when the confidence it provides justifies these costs.
|
||||||
|
Evaluate that tradeoff at two levels:
|
||||||
Apply this cost-benefit analysis at two levels:
|
|
||||||
|
|
||||||
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
||||||
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
The preferred test suite is a **lean suite that provides sufficient confidence in the risks that matter, without redundant or low-value tests**. We seek sufficient confidence with the least unnecessary testing friction, not the fewest possible tests.
|
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. Keep ordinary internal changes inexpensive.
|
||||||
|
|
||||||
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. They should not make ordinary internal changes needlessly expensive.
|
Evaluate maintenance cost against the specific failure being protected. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
||||||
|
|
||||||
The cost of a test is not a reason to omit testing by default. Do not cite maintenance cost abstractly. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
|
||||||
|
|
||||||
## Default testing style
|
## Default testing style
|
||||||
|
|
||||||
@@ -81,6 +70,8 @@ Use a **classical/Detroit-style** approach:
|
|||||||
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
||||||
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
||||||
|
|
||||||
|
Examples of appropriate seams include clocks, randomness, subprocesses, remote APIs, object storage, email, and paid LLM calls.
|
||||||
|
|
||||||
For ConfigKit, controlled input readers and filesystem failures are useful seams.
|
For ConfigKit, controlled input readers and filesystem failures are useful seams.
|
||||||
Prefer actual parsing, composition, and decoding over mocks of their call order.
|
Prefer actual parsing, composition, and decoding over mocks of their call order.
|
||||||
|
|
||||||
@@ -92,7 +83,7 @@ Control clocks, randomness, environment variables, and other process-global or m
|
|||||||
|
|
||||||
## What deserves tests
|
## What deserves tests
|
||||||
|
|
||||||
Prioritize tests for:
|
To the extent the following features are present in the application, prioritize tests for:
|
||||||
|
|
||||||
1. Public and package-level contracts.
|
1. Public and package-level contracts.
|
||||||
2. Domain rules and important invariants.
|
2. Domain rules and important invariants.
|
||||||
@@ -102,15 +93,27 @@ Prioritize tests for:
|
|||||||
6. Previously observed or plausible regressions.
|
6. Previously observed or plausible regressions.
|
||||||
7. Representative integration and end-to-end workflows.
|
7. Representative integration and end-to-end workflows.
|
||||||
|
|
||||||
A package-level contract is behavior relied upon by another package or major collaborator, not every observable detail of a package implementation.
|
A package-level contract comprises behavior relied upon by another package or major collaborator.
|
||||||
|
|
||||||
For behavior involving **data integrity, destructive operations, compatibility, security, concurrency, idempotency, or recovery**, presume that durable tests are required unless the behavior is already credibly protected at another layer.
|
Choose tests for requested behavior and established contracts. Tests must not
|
||||||
|
introduce new restrictions, guarantees, or threat scenarios merely because they
|
||||||
|
could be asserted. Follow the [agent policy](agents.md) when deciding whether a
|
||||||
|
behavior belongs to the contract; current implementation behavior alone is not
|
||||||
|
sufficient authority.
|
||||||
|
|
||||||
|
For established behavior involving **data integrity, destructive operations,
|
||||||
|
compatibility, security, concurrency, idempotency, or recovery**, favor durable
|
||||||
|
tests for realistic failures whose consequences warrant protection. Identify
|
||||||
|
the failure and the existing contract it would violate. These categories call
|
||||||
|
for attention, not an automatic test inventory or permission to strengthen the
|
||||||
|
application's guarantees. Account for protection already provided at other layers.
|
||||||
|
|
||||||
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
||||||
|
|
||||||
## Choose the right test boundary
|
## Choose the right test boundary
|
||||||
|
|
||||||
Test through the narrowest stable boundary that expresses the behavior clearly.
|
Choose the narrowest stable boundary that expresses the behavior clearly and
|
||||||
|
provides durable confidence with minimal incidental coupling.
|
||||||
|
|
||||||
This is often the package API, but it may instead be:
|
This is often the package API, but it may instead be:
|
||||||
|
|
||||||
@@ -118,28 +121,15 @@ This is often the package API, but it may instead be:
|
|||||||
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
||||||
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
||||||
|
|
||||||
Do not force all behavior through oversized end-to-end tests. Do not test every private helper merely because it exists. Choose the boundary that gives durable confidence with the least incidental coupling.
|
|
||||||
|
|
||||||
## Test behavior, not implementation
|
## Test behavior, not implementation
|
||||||
|
|
||||||
A test should protect a decision, contract, or invariant—not memorialize the current implementation.
|
A test should protect a selected decision, contract, or invariant.
|
||||||
|
|
||||||
Before adding or retaining a test, ask:
|
A test is suspect when it primarily detects changes to private constants or
|
||||||
|
helpers, equivalent operation ordering, incidental formatting, equivalent
|
||||||
|
algorithms, or internal structure that preserves behavior.
|
||||||
|
|
||||||
> What realistic defect would this test catch?
|
Behavioral tests should normally remain stable through internal refactoring that preserves the contract.
|
||||||
|
|
||||||
A test is suspect when its main purpose is to detect that someone:
|
|
||||||
|
|
||||||
- changed an internal constant;
|
|
||||||
- renamed or split a private helper;
|
|
||||||
- reordered equivalent internal operations;
|
|
||||||
- changed incidental formatting;
|
|
||||||
- replaced one correct algorithm with another; or
|
|
||||||
- refactored internal object structure without changing behavior.
|
|
||||||
|
|
||||||
Refactoring should normally require no test edits unless the refactored structure is itself part of the contract.
|
|
||||||
|
|
||||||
A test can be factually correct and still have negative value. Accurately describing current behavior is not enough; the protected behavior must be important enough to justify the future friction.
|
|
||||||
|
|
||||||
## Expected effects of different changes
|
## Expected effects of different changes
|
||||||
|
|
||||||
@@ -156,12 +146,13 @@ A test failing is not the same as a test needing to be edited. Many tests may co
|
|||||||
|
|
||||||
## Separate mechanism from policy
|
## Separate mechanism from policy
|
||||||
|
|
||||||
Configurable thresholds and defaults must not be duplicated throughout the test suite.
|
Derive expectations from test-controlled configuration and relationships.
|
||||||
|
|
||||||
For example, do not encode an internal concurrency limit indirectly:
|
For this example, assume the selected contract rejects a request to start more
|
||||||
|
processes than a configured limit. Do not encode its production default indirectly:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Production policy:
|
// Production default:
|
||||||
const maxConcurrency = 4
|
const maxConcurrency = 4
|
||||||
|
|
||||||
// Brittle test:
|
// Brittle test:
|
||||||
@@ -179,25 +170,30 @@ require.NoError(t, runner.Start(limit))
|
|||||||
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
||||||
```
|
```
|
||||||
|
|
||||||
The test should prove:
|
For this selected contract, the test should prove:
|
||||||
|
|
||||||
- the configured limit is accepted; and
|
- the configured limit is accepted; and
|
||||||
- one beyond the configured limit is rejected.
|
- one beyond the configured limit is rejected.
|
||||||
|
|
||||||
|
Rejection is not a general requirement for concurrency control. If the selected
|
||||||
|
contract queues excess work or limits active workers while accepting larger
|
||||||
|
batches, test that behavior instead. Do not add rejection or a configurable
|
||||||
|
limit solely to reproduce this example.
|
||||||
|
|
||||||
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
||||||
|
|
||||||
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior, not duplicated literals.
|
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior.
|
||||||
|
|
||||||
For concurrency limits, test both kinds of behavior when relevant:
|
For established concurrency limits, distinguish these behaviors where the contract requires them:
|
||||||
|
|
||||||
1. **Configuration enforcement:** invalid or excessive requested values are handled correctly.
|
1. **Configuration handling:** values are accepted or rejected according to the selected contract.
|
||||||
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
||||||
|
|
||||||
Use a test-controlled limit and measure the behavior relative to that limit. Do not merely assert today's default value.
|
Use a test-controlled limit and measure the behavior relative to that limit.
|
||||||
|
|
||||||
## Avoid semantic duplication across layers
|
## Assign each behavior a test owner
|
||||||
|
|
||||||
Each behavior should have a clear test owner.
|
For ConfigKit, assign ownership as follows:
|
||||||
|
|
||||||
- YAML boundary tests own syntax and policy enforcement.
|
- YAML boundary tests own syntax and policy enforcement.
|
||||||
- Composition and overlay tests own their operation semantics.
|
- Composition and overlay tests own their operation semantics.
|
||||||
@@ -209,9 +205,7 @@ Each behavior should have a clear test owner.
|
|||||||
|
|
||||||
These are responsibility boundaries, not a required package layout.
|
These are responsibility boundaries, not a required package layout.
|
||||||
|
|
||||||
Higher-level tests should not repeat every lower-level case. A single intentional policy change should not require unrelated edits across many test files.
|
Give each layer its distinct responsibility and keep expectation updates localized to the contract being changed.
|
||||||
|
|
||||||
Tests that are individually reasonable may still be collectively redundant. Evaluate the marginal value of each additional test in light of the protection already provided by the rest of the suite.
|
|
||||||
|
|
||||||
## Use test doubles deliberately
|
## Use test doubles deliberately
|
||||||
|
|
||||||
@@ -232,104 +226,77 @@ Mocks are appropriate when the contract includes facts such as:
|
|||||||
- an expensive API is called no more than once; or
|
- an expensive API is called no more than once; or
|
||||||
- a security audit event is emitted.
|
- a security audit event is emitted.
|
||||||
|
|
||||||
Do not use mocks merely to isolate every object or reproduce the implementation's call graph.
|
|
||||||
|
|
||||||
## Go-specific guidance
|
## Go-specific guidance
|
||||||
|
|
||||||
Use:
|
Select techniques by behavior and risk:
|
||||||
|
|
||||||
- table-driven tests for meaningful behavioral categories and boundaries;
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
- `t.TempDir()` for real filesystem behavior;
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
- fuzz tests for parsers, normalization, path handling, and broad input spaces;
|
- `httptest.Server` for realistic HTTP interactions;
|
||||||
|
- fuzz tests when exploring broad input spaces, such as parsers or path handling, adds useful protection beyond representative cases;
|
||||||
- golden files only when the complete output is intentionally stable;
|
- golden files only when the complete output is intentionally stable;
|
||||||
- integration tests where correctness depends on component interaction; and
|
- integration tests where correctness depends on component interaction; and
|
||||||
- a small number of representative end-to-end tests.
|
- a small number of representative end-to-end tests when assembled workflows expose meaningful risks not adequately covered at narrower boundaries.
|
||||||
|
|
||||||
Avoid exact error-string assertions unless the wording is itself contractual. Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields.
|
Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields. Use exact error-wording assertions only when the wording is contractual.
|
||||||
|
|
||||||
At the public library boundary, prefer diagnostic codes, paths, and source
|
At the public library boundary, prefer diagnostic codes, paths, and source
|
||||||
locations over complete message snapshots. Assert wording only when contractual.
|
locations over complete message snapshots. Assert wording only when contractual.
|
||||||
|
|
||||||
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
||||||
|
|
||||||
Keep tests readable and direct. Test helpers and fixture frameworks must earn their own maintenance cost; do not build elaborate test infrastructure for small or isolated needs.
|
Keep tests readable and direct. Size test helpers and fixture frameworks to the maintenance benefit they provide.
|
||||||
|
|
||||||
## Coverage
|
## Coverage
|
||||||
|
|
||||||
Coverage is a diagnostic, not a target.
|
Use coverage to locate untested critical branches and unexpectedly weak packages. Evaluate test quality through meaningful behavioral protection and choose coverage according to risk.
|
||||||
|
|
||||||
Use it to find untested critical branches and unexpectedly weak packages. Do not write low-value tests solely to increase a percentage, and do not infer test quality from coverage alone.
|
Pure domain logic will often warrant higher coverage than CLI wiring or external adapters. Uneven coverage is acceptable when it reflects risk.
|
||||||
|
|
||||||
Dense configuration semantics will often warrant higher coverage than simple input wiring. Uneven coverage is acceptable when it reflects risk.
|
|
||||||
|
|
||||||
Increasing coverage is valuable only when the newly covered behavior protects a meaningful risk at an acceptable cost.
|
|
||||||
|
|
||||||
## Regression tests
|
## Regression tests
|
||||||
|
|
||||||
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
||||||
|
|
||||||
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant; do not preserve accidental implementation details from the original bug.
|
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant.
|
||||||
|
|
||||||
Not every historical bug requires a permanent test. If the underlying design has made recurrence impossible, the test has become redundant, or a stronger invariant test now subsumes it, remove or consolidate it.
|
Remove or consolidate a test when the underlying design has made recurrence impossible, its protection is redundant, or a stronger invariant test subsumes it.
|
||||||
|
|
||||||
## Deleting or rewriting tests
|
## Deleting or rewriting tests
|
||||||
|
|
||||||
Tests are maintained code, not permanent historical artifacts.
|
Delete or rewrite tests when maintenance cost exceeds their continuing
|
||||||
|
protective value.
|
||||||
Delete or rewrite a test when its maintenance cost exceeds the confidence it provides.
|
|
||||||
|
|
||||||
Strong candidates include tests that:
|
Strong candidates include tests that:
|
||||||
|
|
||||||
- require updates after harmless internal changes;
|
- require updates after harmless internal changes;
|
||||||
- directly assert private constants without protecting a real contract;
|
- assert incidental private constants or snapshot large amounts of incidental output;
|
||||||
- duplicate the same policy across several layers;
|
|
||||||
- verify mock choreography rather than outcomes;
|
- verify mock choreography rather than outcomes;
|
||||||
- snapshot large amounts of incidental output;
|
- duplicate policy across layers, retest trivial helpers covered by package
|
||||||
- test trivial private helpers already exercised through stable package behavior;
|
behavior, or protect risks covered more effectively elsewhere;
|
||||||
- protect risks already covered more effectively elsewhere;
|
|
||||||
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
||||||
- no longer correspond to a plausible failure mode.
|
- no longer correspond to a plausible failure mode.
|
||||||
|
|
||||||
Several brittle tests may encode one genuine requirement. Replace them with one durable behavior-level or invariant test rather than preserving all of them.
|
Several brittle tests may encode one genuine requirement. Consolidate them into one durable behavior-level or invariant test.
|
||||||
|
|
||||||
Deleting a low-value test can improve the quality of the suite by reducing noise, maintenance burden, and friction around legitimate change.
|
|
||||||
|
|
||||||
## Reviewing a proposed test
|
## Reviewing a proposed test
|
||||||
|
|
||||||
Use the following questions when the value, boundary, or durability of a proposed test is not self-evident. Significant test additions should be reviewable against them, but written answers are not required for every routine test.
|
Use the following questions when a proposed test needs closer evaluation. Significant test additions should be reviewable against them; written answers are optional for routine tests.
|
||||||
|
|
||||||
1. What realistic defect would it catch?
|
1. Which requested behavior or established contract does it protect, and what realistic defect would violate it?
|
||||||
2. How likely is that defect?
|
2. How likely and consequential is that defect, and is it already protected elsewhere?
|
||||||
3. How consequential would it be?
|
3. What is the narrowest stable boundary that can test it clearly?
|
||||||
4. Is the behavior already protected elsewhere?
|
4. Would a correct internal refactor or a change to an incidental default require test edits?
|
||||||
5. At which layer should this behavior be owned?
|
5. Does its confidence justify its maintenance, execution, and diagnostic cost, or would a smaller test suffice?
|
||||||
6. Does the test assert a durable contract or an incidental implementation detail?
|
|
||||||
7. Could the implementation be refactored without changing the behavior and without editing this test?
|
|
||||||
8. What should cause this test to fail?
|
|
||||||
9. What legitimate changes should not cause this test to fail?
|
|
||||||
10. What ongoing maintenance, execution, and diagnostic cost will the test impose?
|
|
||||||
11. Is there a smaller or more direct test that protects the same risk?
|
|
||||||
|
|
||||||
Do not add the test when its expected lifetime cost exceeds its expected protective value.
|
|
||||||
|
|
||||||
When deciding not to test plausible behavior, record or be able to explain why the risk is low, already protected, obvious, reversible, or cheaper to detect elsewhere.
|
|
||||||
|
|
||||||
## Definition of sufficient
|
## Definition of sufficient
|
||||||
|
|
||||||
A test suite is sufficient when:
|
A test suite is sufficient when:
|
||||||
|
|
||||||
- important contracts and invariants are protected;
|
- important requested behavior and established contracts are protected against realistic, consequential failures;
|
||||||
- meaningful boundaries and failure modes are exercised;
|
- boundaries and component interactions have coverage where they introduce meaningful risks not protected elsewhere;
|
||||||
- realistic and consequential regressions are credibly protected against silent recurrence;
|
- failures provide useful, distinct signals;
|
||||||
- behavior involving data integrity, destructive operations, compatibility, security, concurrency, idempotency, and recovery is credibly protected;
|
- tests usually remain stable through legitimate internal changes; and
|
||||||
- important external boundaries have realistic integration coverage;
|
|
||||||
- representative complete workflows are tested;
|
|
||||||
- failures provide useful signal rather than redundant noise;
|
|
||||||
- legitimate internal changes usually do not require test edits; and
|
|
||||||
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
||||||
|
|
||||||
Sufficiency is a risk judgment, not a coverage percentage or test count. Reassess it as the library, its consumers, and the consequences of failure evolve.
|
Reassess sufficiency as the application, its users, and the consequences of
|
||||||
|
failure evolve.
|
||||||
The governing rule is:
|
|
||||||
|
|
||||||
> Test heavily where failure is consequential, subtle, or difficult to detect after the fact. Test lightly where failure is obvious, reversible, and inexpensive—and retain no test whose lifetime cost exceeds the confidence it provides.
|
|
||||||
|
|||||||
333
docs/release.md
333
docs/release.md
@@ -1,35 +1,34 @@
|
|||||||
# ConfigKit Release Procedure
|
# ConfigKit Release Procedure
|
||||||
|
|
||||||
This is the maintainer runbook for ConfigKit's [release policy](policy/release.md).
|
This is the maintainer runbook for ConfigKit's [release policy](policy/release.md).
|
||||||
ConfigKit publishes one source-only Go module: the immutable source tag and the
|
ConfigKit publishes one source-only Go module. The immutable annotated tag and
|
||||||
matching checked-in release note are the deliverables. There is no application
|
matching checked-in release note are the deliverables; there is no binary,
|
||||||
binary, container image, generated package, or separate registry publication.
|
container image, generated package, or separate registry publication.
|
||||||
|
|
||||||
## Release identity and support
|
## Release identity and support
|
||||||
|
|
||||||
- Module: `gitea.maximumdirect.net/eric/ConfigKit`
|
- Module: `gitea.maximumdirect.net/eric/ConfigKit`
|
||||||
- Primary branch: `main`
|
- Primary branch: `main`
|
||||||
- Authoritative remote: `origin`, expected to fetch from
|
- Authoritative remote: `origin`, with fetch and push destination
|
||||||
`https://gitea.maximumdirect.net/eric/ConfigKit.git`
|
`https://gitea.maximumdirect.net/eric/ConfigKit.git`
|
||||||
- Tags: stable Semantic Versions such as `v0.1.0`; prerelease tags are not supported
|
- Tags: stable Semantic Versions such as `v0.5.0`; no prereleases
|
||||||
- Minimum Go language/toolchain line: Go 1.25, tested with a supported patched
|
- Minimum Go line: Go 1.25, validated with one maintained patch
|
||||||
Go 1.25 toolchain and one newer supported toolchain
|
- Release-gated targets: Linux amd64 and arm64
|
||||||
- Release-gated build targets: Linux on amd64 and arm64
|
- Best-effort targets: macOS amd64 and arm64, under the
|
||||||
- Best-effort targets: macOS on amd64 and arm64, under the
|
|
||||||
[platform support policy](policy/release.md#platform-support)
|
[platform support policy](policy/release.md#platform-support)
|
||||||
|
|
||||||
The automated checker cross-builds the Linux targets. Before release, the maintainer
|
The checker runs one offline race suite, one full vet pass, and CGO-disabled
|
||||||
must also obtain native test, race, symlink, and permission-fixture evidence on Linux;
|
builds for both Linux targets. It reports skipped filesystem cases. macOS checks
|
||||||
cross-compilation is not native execution evidence. Native macOS checks and Darwin
|
and newer-toolchain tests are optional. CI is never a readiness or completion
|
||||||
cross-builds are optional and do not gate publication.
|
gate; do not wait for or poll it.
|
||||||
|
|
||||||
## 1. Prepare access and tools
|
## 1. Prepare access and tools
|
||||||
|
|
||||||
The release maintainer owns this procedure. Work in a dedicated clone with Git, Bash 3.2 or newer,
|
Use a clean checkout with Git, Bash 3.2 or newer, a maintained Go 1.25 patch,
|
||||||
and two supported Go toolchains available. The checker supports the stock macOS
|
and a native compiler for race tests. Configure private-host access through the
|
||||||
Bash; its filename enumeration is null-delimited, including names with whitespace. Configure private-host Git and Go module
|
normal credential manager. Keep credentials and environment dumps outside the
|
||||||
access through the normal credential manager before starting. Keep tokens, passwords,
|
repository and command transcript.
|
||||||
SSH material, and environment dumps outside the repository and command transcript.
|
|
||||||
Verify access without displaying credentials:
|
Verify access without displaying credentials:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -37,208 +36,164 @@ git remote get-url origin
|
|||||||
git ls-remote origin HEAD
|
git ls-remote origin HEAD
|
||||||
```
|
```
|
||||||
|
|
||||||
The remote URL must equal the authoritative URL above. Select the latest supported
|
The fetch URL and all configured push destinations must resolve to the
|
||||||
patch in the Go 1.25 line and a newer supported toolchain. The values below are the
|
authoritative URL above. The publication command checks this again. Acquire the
|
||||||
toolchains used while this runbook was introduced; update them to supported patch
|
selected toolchain and dependencies explicitly before offline validation:
|
||||||
releases during candidate preparation and record the actual versions in the release
|
|
||||||
note or validation record.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export CONFIGKIT_BASELINE_TOOLCHAIN=go1.25.5
|
export CONFIGKIT_BASELINE_TOOLCHAIN=go1.25.14
|
||||||
export CONFIGKIT_NEWER_TOOLCHAIN=go1.26.7
|
|
||||||
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go version
|
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go version
|
||||||
GOTOOLCHAIN="$CONFIGKIT_NEWER_TOOLCHAIN" go version
|
|
||||||
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go mod download
|
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go mod download
|
||||||
GOTOOLCHAIN="$CONFIGKIT_NEWER_TOOLCHAIN" go mod download
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Those commands explicitly acquire toolchains and dependencies. The checker itself
|
A maintained patch may replace the example pin. No per-release latest-version
|
||||||
sets `GOPROXY=off` and fails if its required cache is incomplete.
|
survey is required. Dependencies must be cached; the checker sets `GOPROXY=off`.
|
||||||
|
Publication requires user authorization. Standing authorization for local
|
||||||
|
commits does not authorize a push or release.
|
||||||
|
|
||||||
## 2. Select the version and review compatibility
|
## 2. Select the version and review compatibility
|
||||||
|
|
||||||
Choose an unused stable version and compare the candidate with the previous tag.
|
Choose an unused stable version. Compare the candidate with the previous tag.
|
||||||
For the first release, review the whole public surface and current contracts.
|
Review exported Go signatures and ownership, YAML and scalar semantics,
|
||||||
|
precedence, diagnostic codes, minimum Go version, and platform support. A
|
||||||
|
signature-preserving change may still affect consumers. Before `v1.0.0`,
|
||||||
|
intentional incompatible minor-release changes need a note explaining impact
|
||||||
|
and consumer action; patch releases remain compatible within their minor line.
|
||||||
|
Review the maintained consumer examples and migration guide.
|
||||||
|
|
||||||
|
When dependencies change, review parser behavior and migration impact as part
|
||||||
|
of that change. Module tidiness belongs to dependency-change review, not the
|
||||||
|
release checker. Do not repeat a dependency-version survey for every release.
|
||||||
|
|
||||||
|
## 3. Write and commit the release note
|
||||||
|
|
||||||
|
Create `docs/releases/<version>.md` for the selected version. Its first line
|
||||||
|
must be `# ConfigKit <version>`. Give a meaningful summary and include
|
||||||
|
compatibility impact or upgrade instructions when applicable. Link to current
|
||||||
|
contracts for exact behavior. Review the note and affected canonical documents
|
||||||
|
as ordinary preparation, then commit the complete candidate.
|
||||||
|
|
||||||
|
End every new note with these links, replacing `VERSION` with the complete tag:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/docs/oss/attribution.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
Confirm the three target files exist in the candidate and review the version in
|
||||||
|
the URLs. The future tag need not resolve remotely yet; this review adds no
|
||||||
|
network gate. ConfigKit uses checked-in notes without hosted release objects.
|
||||||
|
If a hosted page is used later, reuse the note and preserve its footer. Do not
|
||||||
|
rewrite historical notes or add downloadable license assets.
|
||||||
|
|
||||||
|
## 4. Publish the committed candidate
|
||||||
|
|
||||||
|
Before publication, review compatibility, release-note accuracy, and the file
|
||||||
|
list for unintended content or credentials. Retire completed roadmaps as part of
|
||||||
|
release preparation, preserving unfinished and deferred work and repairing
|
||||||
|
links. These are ordinary preparation tasks, not separate human sign-offs.
|
||||||
|
|
||||||
|
With the release explicitly authorized, run the one publication command.
|
||||||
|
The script resolves the repository root from its own path, so it may be invoked
|
||||||
|
from another directory by using its path there. Replace the sample version with
|
||||||
|
the selected version:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
release_version=v0.1.0
|
./scripts/release.sh v0.5.0
|
||||||
printf '%s\n' "$release_version" | grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
```
|
||||||
git show-ref --verify --quiet "refs/tags/$release_version" && exit 1 || :
|
|
||||||
if git ls-remote --exit-code --tags origin "refs/tags/$release_version" >/dev/null; then
|
The command requires `main`, a clean index/worktree, an unused version locally
|
||||||
printf 'remote tag already exists: %s\n' "$release_version" >&2
|
and on the authoritative remote, and a matching note in the captured commit.
|
||||||
exit 1
|
Ignored local files do not block it. It checks remote ancestry, runs
|
||||||
|
[`release-check.sh`](../scripts/release-check.sh) once against that commit,
|
||||||
|
rechecks candidate and version state, pushes only that commit to `main`, then
|
||||||
|
creates and pushes one annotated tag. The tag message is the checked-in note.
|
||||||
|
It never commits or repairs the checkout.
|
||||||
|
|
||||||
|
A successful intended tag push completes publication. The command reports the
|
||||||
|
version and commit immediately. No CI, module retrieval, remote read-back, or
|
||||||
|
hosted release object is required. The checker may be run separately for
|
||||||
|
diagnosis, but it is not a prerequisite: a fresh publication invocation
|
||||||
|
validates its candidate once.
|
||||||
|
|
||||||
|
## 5. Recover from a failed or uncertain push
|
||||||
|
|
||||||
|
The command performs one bounded authoritative-state check after a failed push.
|
||||||
|
If the main push failed but authoritative main equals the candidate, it proceeds.
|
||||||
|
If the tag push failed but its exact tag object reached the remote, it reports
|
||||||
|
success. Otherwise it reports branch-only, conflicting, or unknown state and
|
||||||
|
retains any local tag.
|
||||||
|
|
||||||
|
Inspect exact refs before any retry. Set `release_version` to the attempted
|
||||||
|
version and compare main with the candidate from the command's report:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
release_version=v0.5.0
|
||||||
|
authoritative=https://gitea.maximumdirect.net/eric/ConfigKit.git
|
||||||
|
if remote_main=$(git ls-remote --refs --exit-code "$authoritative" refs/heads/main); then
|
||||||
|
printf 'remote main: %s\n' "$remote_main"
|
||||||
else
|
else
|
||||||
test $? -eq 2
|
result=$?
|
||||||
|
if [ "$result" -eq 2 ]; then
|
||||||
|
printf 'authoritative main confirmed absent\n' >&2
|
||||||
|
else
|
||||||
|
printf 'remote main state unknown; inspect before retrying\n' >&2
|
||||||
fi
|
fi
|
||||||
git log --oneline --decorate --no-merges
|
fi
|
||||||
```
|
ref="refs/tags/$release_version"
|
||||||
|
if remote_tag=$(git ls-remote --refs --exit-code "$authoritative" "$ref"); then
|
||||||
Review exported Go signatures and ownership, YAML and scalar behavior, precedence,
|
printf 'remote tag: %s\n' "$remote_tag"
|
||||||
diagnostic codes, minimum Go version, and platform support. Before `v1.0.0`, any
|
|
||||||
intentional incompatible minor-release change must be explained with consumer action;
|
|
||||||
patch releases must remain compatible within their minor line. Review the maintained
|
|
||||||
consumer examples and the migration guide even when signatures did not change.
|
|
||||||
|
|
||||||
Reassess `go.yaml.in/yaml/v4` rather than using `@latest` implicitly:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
go list -m -versions go.yaml.in/yaml/v4
|
|
||||||
go list -m -json go.yaml.in/yaml/v4@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
If changing the explicit pin, make that a reviewed dependency change and rerun the
|
|
||||||
complete checker, especially parser policy, limits, diagnostics, and rendering tests.
|
|
||||||
If retaining a prerelease pin, record that decision in Compatibility.
|
|
||||||
|
|
||||||
## 3. Write the release note
|
|
||||||
|
|
||||||
Create `docs/releases/$release_version.md` before selecting the candidate. It must
|
|
||||||
begin with `# ConfigKit $release_version` and contain `Summary`, `Compatibility`,
|
|
||||||
`Upgrade`, and `Changes` sections. Use “No action required” where appropriate. Link
|
|
||||||
to current canonical contracts instead of copying their definitions. Do not create a
|
|
||||||
release note until there is a real candidate and reviewed content.
|
|
||||||
|
|
||||||
## 4. Validate the source candidate
|
|
||||||
|
|
||||||
Run the complete checker on Linux from the repository root after dependencies have been
|
|
||||||
acquired. It validates module manifests in a disposable copy, both supported Go
|
|
||||||
toolchains, offline default tests, the native race detector, vet, native builds,
|
|
||||||
CGO-disabled Linux cross-builds, formatting and whitespace (including untracked files),
|
|
||||||
examples, package isolation, and local documentation links.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
./scripts/release-check.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
`go vet` is the repository's static-analysis baseline. No additional linter is
|
|
||||||
claimed. Links to current ConfigKit files and headings are strict. Recorded links to
|
|
||||||
sibling consumer source are checked when those checkouts exist and are otherwise
|
|
||||||
inapplicable in an isolated clone; their immutable revisions remain recorded in the
|
|
||||||
extraction inventory.
|
|
||||||
|
|
||||||
Complete these manual gates and record their evidence with the candidate:
|
|
||||||
|
|
||||||
- The maintainer reviews compatibility and downstream migration impact against
|
|
||||||
`docs/config.md`, Go API comments, and the consumer guide.
|
|
||||||
- The maintainer inspects `git status --short`, `git diff`, and the candidate file
|
|
||||||
list for credentials, private data, generated output, unintended files, and
|
|
||||||
unrelated changes.
|
|
||||||
- The maintainer records a successful native checker run on Linux, including
|
|
||||||
filesystem capability tests. Missing required Linux evidence blocks release;
|
|
||||||
no macOS run, sign-off, or cross-build result is required.
|
|
||||||
- The maintainer removes completed, obsolete documents under `docs/roadmap/`, repairs
|
|
||||||
inbound links, and reruns the checker. ADR rationale remains historical.
|
|
||||||
- The maintainer reviews the exact version-matched release note for accuracy and
|
|
||||||
confirms it describes only deliverables that will actually be published.
|
|
||||||
|
|
||||||
## 5. Commit, push, and record the candidate
|
|
||||||
|
|
||||||
Commit all candidate source, contract, example, roadmap-retirement, and release-note
|
|
||||||
changes, rerun the checker against that clean commit, then push only `main` and record
|
|
||||||
the exact commit in Git metadata local to the clone:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git add .
|
|
||||||
git commit --message "Prepare ConfigKit $release_version"
|
|
||||||
./scripts/release-check.sh
|
|
||||||
test -z "$(git status --porcelain=v1 --untracked-files=all)"
|
|
||||||
git push origin HEAD:refs/heads/main
|
|
||||||
git rev-parse HEAD | tee .git/configkit-release-candidate
|
|
||||||
candidate_commit=$(cat .git/configkit-release-candidate)
|
|
||||||
```
|
|
||||||
|
|
||||||
If review changes the source after this point, create and validate a new candidate;
|
|
||||||
do not reuse the recorded commit.
|
|
||||||
|
|
||||||
## 6. Run publication guards
|
|
||||||
|
|
||||||
Immediately before tagging, fetch the authoritative branch and tags, restore the
|
|
||||||
recorded variables if this is a new shell, and execute every guard:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
release_version=v0.1.0
|
|
||||||
candidate_commit=$(cat .git/configkit-release-candidate)
|
|
||||||
git fetch --prune origin main
|
|
||||||
git fetch --tags origin
|
|
||||||
test "$(git branch --show-current)" = main
|
|
||||||
test -z "$(git status --porcelain=v1 --untracked-files=all)"
|
|
||||||
test "$(git rev-parse HEAD)" = "$candidate_commit"
|
|
||||||
test "$(git rev-parse refs/remotes/origin/main)" = "$candidate_commit"
|
|
||||||
test "$(git remote get-url origin)" = 'https://gitea.maximumdirect.net/eric/ConfigKit.git'
|
|
||||||
printf '%s\n' "$release_version" | grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
|
||||||
test -f "docs/releases/$release_version.md"
|
|
||||||
test "$(sed -n '1p' "docs/releases/$release_version.md")" = "# ConfigKit $release_version"
|
|
||||||
for heading in Summary Compatibility Upgrade Changes; do
|
|
||||||
grep -Fxq "## $heading" "docs/releases/$release_version.md"
|
|
||||||
done
|
|
||||||
git show-ref --verify --quiet "refs/tags/$release_version" && exit 1 || :
|
|
||||||
if git ls-remote --exit-code --tags origin "refs/tags/$release_version" >/dev/null; then
|
|
||||||
printf 'remote tag already exists: %s\n' "$release_version" >&2
|
|
||||||
exit 1
|
|
||||||
else
|
else
|
||||||
test $? -eq 2
|
result=$?
|
||||||
|
if [ "$result" -eq 2 ]; then
|
||||||
|
printf 'remote tag confirmed absent\n'
|
||||||
|
else
|
||||||
|
printf 'remote tag state unknown; do not reuse the version\n' >&2
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if local_tag=$(git rev-parse --verify "refs/tags/$release_version" 2>/dev/null); then
|
||||||
|
printf 'local tag object: %s\n' "$local_tag"
|
||||||
|
else
|
||||||
|
printf 'no local tag object\n'
|
||||||
fi
|
fi
|
||||||
```
|
```
|
||||||
|
|
||||||
Confirm the recorded automated and manual approvals apply to exactly
|
A query failure is not proof that the tag is absent. Compare the remote tag
|
||||||
`$candidate_commit`. A successful older run is not evidence for a changed commit.
|
object ID with the local annotated tag object ID; its peeled commit alone is
|
||||||
|
insufficient to establish identical publication. A conflicting published tag
|
||||||
## 7. Tag and publish the exact ref
|
must not be moved or replaced. If remote main advanced but the tag was not
|
||||||
|
published, report that partial progress. Only after confirming the local tag
|
||||||
Create one annotated tag at the guarded commit, verify its peeled target, and push
|
was never published or used by another channel may a maintainer remove it:
|
||||||
only that ref. Do not use `git push --tags`.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git tag --annotate "$release_version" --message "ConfigKit $release_version" "$candidate_commit"
|
git tag -d "$release_version"
|
||||||
test "$(git rev-list -n 1 "$release_version")" = "$candidate_commit"
|
|
||||||
git push origin "refs/tags/$release_version:refs/tags/$release_version"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The pushed tag completes the declared source-only publication. No Gitea release
|
A subsequent invocation revalidates the candidate; a correctly published tag
|
||||||
object or binary upload is required.
|
needs no rerun. Do not roll back main or automatically delete a tag. Transport
|
||||||
|
or authentication failure alone does not require a new version. A defect in
|
||||||
|
published source requires a corrected commit, a new semantically appropriate
|
||||||
|
version and note, and the release procedure again.
|
||||||
|
|
||||||
## 8. Verify publication and clean consumer retrieval
|
## 6. Optional consumer verification
|
||||||
|
|
||||||
Verify the authoritative tag and then retrieve that exact version into a new module
|
Only when useful or requested, read back the remote tag or retrieve the exact
|
||||||
without a local `replace` directive. Private-host credentials must already be
|
version into a new module without a local `replace` directive. These checks
|
||||||
configured. Use direct origin retrieval unless an explicitly approved internal Go
|
are optional and non-gating. Do not poll CI or wait for module propagation.
|
||||||
proxy is the publication channel.
|
Private-host credentials must already be configured. For direct-origin
|
||||||
|
verification, set the version to the release just published (replace the sample
|
||||||
|
below), then use a temporary consumer module and check the exact module path
|
||||||
|
and version reported by `go list -m`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
remote_tag_commit=$(git ls-remote origin "refs/tags/$release_version^{}" | awk '{print $1}')
|
release_version=v0.5.0
|
||||||
test "$remote_tag_commit" = "$candidate_commit"
|
|
||||||
consumer_dir=$(mktemp -d)
|
consumer_dir=$(mktemp -d)
|
||||||
(
|
(
|
||||||
cd "$consumer_dir"
|
cd "$consumer_dir"
|
||||||
go mod init example.invalid/configkit-release-check
|
go mod init example.invalid/configkit-release-check
|
||||||
GOPRIVATE=gitea.maximumdirect.net GOPROXY=direct go get "gitea.maximumdirect.net/eric/ConfigKit@$release_version"
|
GOPRIVATE=gitea.maximumdirect.net GOPROXY=direct go get "gitea.maximumdirect.net/eric/ConfigKit@$release_version"
|
||||||
cat > main.go <<'EOF'
|
|
||||||
package main
|
|
||||||
|
|
||||||
import configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
_ = configkit.NoSource()
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
gofmt -w main.go
|
|
||||||
go test ./...
|
|
||||||
go build ./...
|
|
||||||
go list -m -f '{{.Path}} {{.Version}}' gitea.maximumdirect.net/eric/ConfigKit
|
go list -m -f '{{.Path}} {{.Version}}' gitea.maximumdirect.net/eric/ConfigKit
|
||||||
)
|
)
|
||||||
rm -rf -- "$consumer_dir"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The final `go list` output must show the exact module path and `$release_version`.
|
The output should show the exact module path and selected version. Report this
|
||||||
Record the result with the release evidence.
|
optional check separately from publication success.
|
||||||
|
|
||||||
## 9. Handle failures without replacement
|
|
||||||
|
|
||||||
Before publication, fix the candidate, rerun every gate, commit, push, and record a
|
|
||||||
new exact candidate. An unpublished local tag may be deleted only after verifying it
|
|
||||||
was never pushed or used by another release channel.
|
|
||||||
|
|
||||||
After publication, never move, delete, or recreate the tag and never replace its
|
|
||||||
release note. Correct the defect on `main`, choose a new semantically appropriate
|
|
||||||
version, and repeat this procedure. A supported advisory or deprecation mechanism
|
|
||||||
may warn consumers about the old version but cannot change its contents.
|
|
||||||
|
|||||||
56
docs/releases/v0.4.0.md
Normal file
56
docs/releases/v0.4.0.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# ConfigKit v0.4.0
|
||||||
|
|
||||||
|
This release renames selected configuration profiles to overlays, intentionally
|
||||||
|
breaking the previous naming contract without compatibility aliases or fallback.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Selected configuration now uses `Options.Overlay` and `overlays/<name>.yml`.
|
||||||
|
Selection, merge rules, input precedence, and lifecycle behavior are unchanged.
|
||||||
|
See the [selected-overlay contract](../config.md#selected-overlays).
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This is a breaking minor release before v1.0.0. Four surfaces change:
|
||||||
|
|
||||||
|
- Go API: `Options.Profile` becomes `Options.Overlay`, `LayerProfile` becomes
|
||||||
|
`LayerOverlay`, and all seven `CodeProfile*` constants become `CodeOverlay*`.
|
||||||
|
- Selected files: `profiles/<name>.yml` becomes `overlays/<name>.yml`; there is
|
||||||
|
no legacy-directory fallback.
|
||||||
|
- Provenance: the layer string changes from `profile` to `overlay`.
|
||||||
|
- Structured diagnostics: the `profile.*` code prefix becomes `overlay.*`.
|
||||||
|
|
||||||
|
The old Go identifiers are removed. Application-owned concepts such as
|
||||||
|
`ModelProfile` and `model_profile` are unchanged. Ordinary explicit imports from
|
||||||
|
a directory named `profiles` remain valid base inputs.
|
||||||
|
|
||||||
|
The minimum Go version remains 1.25. Linux remains release-validated and macOS
|
||||||
|
remains best-effort. The YAML dependency remains pinned to
|
||||||
|
`go.yaml.in/yaml/v4 v4.0.0-rc.6`; this release does not change parser dependencies.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Update the dependency:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.0
|
||||||
|
```
|
||||||
|
|
||||||
|
Rename the affected Go identifiers, move selected files into `overlays/`, update
|
||||||
|
any handling of provenance-layer and diagnostic-code strings, and rebuild.
|
||||||
|
The maintained example helper is now `LoadNarratioOverlay` rather than
|
||||||
|
`LoadNarratioProfile`. Application CLI flag names remain application-owned;
|
||||||
|
ConfigKit does not require renaming domain-specific profile concepts.
|
||||||
|
See the [migration guide](../consumers/README.md#selected-overlay-migration).
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Rename the selected feature consistently across the public facade, internal
|
||||||
|
engine, diagnostics, source labels, examples, and current documentation.
|
||||||
|
- Add regression coverage for the new directory, absence of legacy fallback,
|
||||||
|
public values, explanations, and preservation of application profile fields.
|
||||||
|
- Align contributor policies with the current shared standard.
|
||||||
|
- Simplify release validation to one local minimum-toolchain check. CI is not a
|
||||||
|
release gate; successful publication of the intended tag completes the
|
||||||
|
source-only release. See the [release procedure](../release.md).
|
||||||
|
- Retire completed overlay and release-workflow planning documents to Git history.
|
||||||
42
docs/releases/v0.4.1.md
Normal file
42
docs/releases/v0.4.1.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# ConfigKit v0.4.1
|
||||||
|
|
||||||
|
This release formalizes ConfigKit's licensing and upstream attribution
|
||||||
|
documentation without changing library behavior.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
ConfigKit now includes an explicit LGPL-3.0-or-later grant in COPYRIGHT,
|
||||||
|
complete LGPLv3 and incorporated GPLv3 license texts, and centralized upstream
|
||||||
|
attribution. README and release guidance provide navigation to those materials.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
No Go code, public API, configuration semantics, diagnostic behavior, or
|
||||||
|
dependencies changed from v0.4.0. The minimum Go version remains 1.25, Linux
|
||||||
|
remains release-validated, and macOS remains best-effort. The YAML dependency
|
||||||
|
remains `go.yaml.in/yaml/v4 v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
The project grant is explicitly LGPL-3.0-or-later. Third-party material remains
|
||||||
|
subject to its respective terms, recorded in the attribution document below.
|
||||||
|
Published earlier releases are unchanged.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Update the module dependency and rebuild to select this release:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.1
|
||||||
|
```
|
||||||
|
|
||||||
|
No application-code or configuration migration is required from v0.4.0.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Add the project COPYRIGHT statement and complete standard project license texts.
|
||||||
|
- Document go-yaml attribution with exact upstream revision links and local
|
||||||
|
Apache-2.0 and MIT license texts.
|
||||||
|
- Adopt the house OSS policy and connect licensing ownership and contributor guidance.
|
||||||
|
- Add license and attribution navigation to README and future release documents,
|
||||||
|
without adding release gates or changing publication mechanics.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/docs/oss/attribution.md)
|
||||||
45
docs/releases/v0.4.2.md
Normal file
45
docs/releases/v0.4.2.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# ConfigKit v0.4.2
|
||||||
|
|
||||||
|
This patch release simplifies and safeguards source publication and aligns
|
||||||
|
maintainer policy and licensing guidance. Library behavior is unchanged.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Maintainers can now publish a prepared release with one guarded command. It
|
||||||
|
validates the exact committed candidate, checks the authoritative destination,
|
||||||
|
and pushes only the candidate on `main` and its annotated version tag. The
|
||||||
|
[release procedure](../release.md) explains preparation and partial-publication
|
||||||
|
recovery; successful tag publication completes the source-only release without
|
||||||
|
waiting for CI or consumer retrieval.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
No Go code, public API, configuration semantics, diagnostic behavior, or
|
||||||
|
dependencies changed from v0.4.1. The minimum Go version remains 1.25. Linux
|
||||||
|
amd64 and arm64 remain release-validated; macOS remains best-effort. The YAML
|
||||||
|
dependency remains `go.yaml.in/yaml/v4 v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Select this version and rebuild:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.2
|
||||||
|
```
|
||||||
|
|
||||||
|
No application-code or configuration migration is required from v0.4.1.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Add guarded single-command publication with exact candidate, version, and
|
||||||
|
remote checks; note-derived annotated tags; and bounded failed-push recovery.
|
||||||
|
- Keep one offline race suite, one full vet pass, and Linux amd64/arm64 builds
|
||||||
|
as release gates. Formatting and whitespace remain development checks;
|
||||||
|
dependency tidiness is reviewed when dependencies change.
|
||||||
|
- Align adopted policies and contributor guidance with their pinned upstream
|
||||||
|
revision, and include the CC BY-SA 4.0 license text and attribution for
|
||||||
|
adapted policy material. The project grant remains LGPL-3.0-or-later.
|
||||||
|
- Retire completed release-workflow and policy-alignment planning records while
|
||||||
|
preserving their history in Git. Deferred scope remains documented.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/docs/oss/attribution.md)
|
||||||
@@ -15,7 +15,7 @@ The initial release deliberately excludes:
|
|||||||
|
|
||||||
- automatic `conf.d` discovery;
|
- automatic `conf.d` discovery;
|
||||||
- remote imports, arbitrary providers, and additional configuration formats;
|
- remote imports, arbitrary providers, and additional configuration formats;
|
||||||
- custom merge strategies, sequence merging, reset operators, and profile inheritance;
|
- custom merge strategies, sequence merging, reset operators, and overlay inheritance;
|
||||||
- parser-specific or custom structural-decoding extension APIs;
|
- parser-specific or custom structural-decoding extension APIs;
|
||||||
- generic dynamic-subtree conversion and module-registry APIs;
|
- generic dynamic-subtree conversion and module-registry APIs;
|
||||||
- automatic schema migrations;
|
- automatic schema migrations;
|
||||||
|
|||||||
@@ -29,14 +29,14 @@ type NarratioConfig struct {
|
|||||||
|
|
||||||
// LoadNarratio loads the maintained import fixture with Narratio-shaped rules.
|
// LoadNarratio loads the maintained import fixture with Narratio-shaped rules.
|
||||||
func LoadNarratio(path string) (*configkit.Result[NarratioConfig], error) {
|
func LoadNarratio(path string) (*configkit.Result[NarratioConfig], error) {
|
||||||
return LoadNarratioProfile(path, "")
|
return LoadNarratioOverlay(path, "")
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadNarratioProfile selects a ConfigKit configuration overlay independently
|
// LoadNarratioOverlay selects a ConfigKit configuration overlay independently
|
||||||
// from the application's ModelProfile field.
|
// from the application's ModelProfile field.
|
||||||
func LoadNarratioProfile(path, profile string) (*configkit.Result[NarratioConfig], error) {
|
func LoadNarratioOverlay(path, overlay string) (*configkit.Result[NarratioConfig], error) {
|
||||||
return configkit.Load(configkit.File(path), configkit.Options[NarratioConfig]{
|
return configkit.Load(configkit.File(path), configkit.Options[NarratioConfig]{
|
||||||
Imports: true, Profile: profile,
|
Imports: true, Overlay: overlay,
|
||||||
Definition: configkit.Definition[NarratioConfig]{
|
Definition: configkit.Definition[NarratioConfig]{
|
||||||
Defaults: func() NarratioConfig { return NarratioConfig{PollInterval: time.Minute} },
|
Defaults: func() NarratioConfig { return NarratioConfig{PollInterval: time.Minute} },
|
||||||
Resolve: resolveNarratio,
|
Resolve: resolveNarratio,
|
||||||
|
|||||||
@@ -92,10 +92,13 @@ func TestMaintainedConsumerFixturesPreserveDomainOutcomes(t *testing.T) {
|
|||||||
if origin, ok := narratio.Metadata().Lookup(configkit.Keys("artifacts", "transcript", "output")); !ok || origin.Origin.Layer != configkit.LayerResolution {
|
if origin, ok := narratio.Metadata().Lookup(configkit.Keys("artifacts", "transcript", "output")); !ok || origin.Origin.Layer != configkit.LayerResolution {
|
||||||
t.Fatalf("artifact origin = %#v, %v", origin, ok)
|
t.Fatalf("artifact origin = %#v, %v", origin, ok)
|
||||||
}
|
}
|
||||||
profiled, err := consumers.LoadNarratioProfile(fixture("narratio", "pipeline.yml"), "testing")
|
overlaid, err := consumers.LoadNarratioOverlay(fixture("narratio", "pipeline.yml"), "testing")
|
||||||
if err != nil || profiled.Config.PollInterval.String() != "2m0s" ||
|
if err != nil || overlaid.Config.PollInterval.String() != "2m0s" ||
|
||||||
profiled.Config.ModelProfile != "concise" || len(profiled.Sources()) != 3 {
|
overlaid.Config.ModelProfile != "concise" || len(overlaid.Sources()) != 3 {
|
||||||
t.Fatalf("configuration/application profiles = %#v, %v", profiled, err)
|
t.Fatalf("configuration overlay and application model profile = %#v, %v", overlaid, err)
|
||||||
|
}
|
||||||
|
if source := overlaid.Sources()[2]; source.Label != "overlays/testing.yml" || source.Layer != configkit.LayerOverlay {
|
||||||
|
t.Fatalf("Narratio overlay source = %#v", source)
|
||||||
}
|
}
|
||||||
|
|
||||||
notarius, err := consumers.LoadNotarius(fixture("notarius", "config.yml"))
|
notarius, err := consumers.LoadNotarius(fixture("notarius", "config.yml"))
|
||||||
@@ -200,7 +203,7 @@ func TestMigrationFixturesFailWithStableCodesAndPaths(t *testing.T) {
|
|||||||
if len(diagnostics) == 0 || diagnostics[0].Code != test.code || diagnostics[0].Path.String() != test.path {
|
if len(diagnostics) == 0 || diagnostics[0].Code != test.code || diagnostics[0].Path.String() != test.path {
|
||||||
t.Fatalf("diagnostics = %#v", diagnostics)
|
t.Fatalf("diagnostics = %#v", diagnostics)
|
||||||
}
|
}
|
||||||
if strings.Contains(diagnostics[0].Message, "wrong-before-profile") {
|
if strings.Contains(diagnostics[0].Message, "wrong-before-overlay") {
|
||||||
t.Fatalf("diagnostic exposed raw parser input: %#v", diagnostics[0])
|
t.Fatalf("diagnostic exposed raw parser input: %#v", diagnostics[0])
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -181,24 +181,24 @@ func nodeImportDiagnostic(code Code, path Path, message string, node *document.N
|
|||||||
return Diagnostic{Code: code, Severity: SeverityError, Path: path, Message: message, Primary: &location}
|
return Diagnostic{Code: code, Severity: SeverityError, Path: path, Message: message, Primary: &location}
|
||||||
}
|
}
|
||||||
|
|
||||||
func profileDirectiveDiagnostics(node *document.Node, current Path) []Diagnostic {
|
func overlayDirectiveDiagnostics(node *document.Node, current Path) []Diagnostic {
|
||||||
if node.Kind == document.Mapping {
|
if node.Kind == document.Mapping {
|
||||||
for _, entry := range node.Mapping {
|
for _, entry := range node.Mapping {
|
||||||
childPath := current.Key(entry.Key)
|
childPath := current.Key(entry.Key)
|
||||||
if entry.Key == directiveKey {
|
if entry.Key == directiveKey {
|
||||||
location := publicLocation(entry.KeyLocation)
|
location := publicLocation(entry.KeyLocation)
|
||||||
return []Diagnostic{{
|
return []Diagnostic{{
|
||||||
Code: CodeProfileDirective, Severity: SeverityError, Path: childPath,
|
Code: CodeOverlayDirective, Severity: SeverityError, Path: childPath,
|
||||||
Message: "profiles cannot contain configuration directives", Primary: &location,
|
Message: "overlays cannot contain configuration directives", Primary: &location,
|
||||||
}}
|
}}
|
||||||
}
|
}
|
||||||
if diagnostics := profileDirectiveDiagnostics(entry.Value, childPath); len(diagnostics) != 0 {
|
if diagnostics := overlayDirectiveDiagnostics(entry.Value, childPath); len(diagnostics) != 0 {
|
||||||
return diagnostics
|
return diagnostics
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else if node.Kind == document.Sequence {
|
} else if node.Kind == document.Sequence {
|
||||||
for index, child := range node.Sequence {
|
for index, child := range node.Sequence {
|
||||||
if diagnostics := profileDirectiveDiagnostics(child, current.Index(index)); len(diagnostics) != 0 {
|
if diagnostics := overlayDirectiveDiagnostics(child, current.Index(index)); len(diagnostics) != 0 {
|
||||||
return diagnostics
|
return diagnostics
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ func (r *Inspection) WriteExplanation(output io.Writer, path Path) error {
|
|||||||
rendered.WriteString(" - representation: ")
|
rendered.WriteString(" - representation: ")
|
||||||
if change.Origin.Operation == ChangeDecoding {
|
if change.Origin.Operation == ChangeDecoding {
|
||||||
rendered.WriteString("input to canonical typed\n")
|
rendered.WriteString("input to canonical typed\n")
|
||||||
} else if change.Origin.Layer == LayerBase || change.Origin.Layer == LayerProfile || change.Origin.Layer == LayerCLI {
|
} else if change.Origin.Layer == LayerBase || change.Origin.Layer == LayerOverlay || change.Origin.Layer == LayerCLI {
|
||||||
rendered.WriteString("policy-validated input\n")
|
rendered.WriteString("policy-validated input\n")
|
||||||
} else {
|
} else {
|
||||||
rendered.WriteString("canonical typed\n")
|
rendered.WriteString("canonical typed\n")
|
||||||
|
|||||||
@@ -21,13 +21,13 @@ type explanationConcurrency struct {
|
|||||||
} `yaml:"transcription"`
|
} `yaml:"transcription"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExplainShowsDefaultBaseAndEffectiveProfileValue(t *testing.T) {
|
func TestExplainShowsDefaultBaseAndEffectiveOverlayValue(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "config.yml", "configkit:\n imports: [{path: transcription.yml}]\n")
|
mainPath := writeImportFile(t, directory, "config.yml", "configkit:\n imports: [{path: transcription.yml}]\n")
|
||||||
writeImportFile(t, directory, "transcription.yml", "transcription:\n concurrency: 8\n")
|
writeImportFile(t, directory, "transcription.yml", "transcription:\n concurrency: 8\n")
|
||||||
writeImportFile(t, directory, filepath.Join("profiles", "testing.yml"), "transcription:\n concurrency: 1\n")
|
writeImportFile(t, directory, filepath.Join("overlays", "testing.yml"), "transcription:\n concurrency: 1\n")
|
||||||
result, err := testLoad[explanationConcurrency](File(mainPath), Options[explanationConcurrency]{
|
result, err := testLoad[explanationConcurrency](File(mainPath), Options[explanationConcurrency]{
|
||||||
Imports: true, Profile: "testing",
|
Imports: true, Overlay: "testing",
|
||||||
Definition: Definition[explanationConcurrency]{Defaults: func() explanationConcurrency {
|
Definition: Definition[explanationConcurrency]{Defaults: func() explanationConcurrency {
|
||||||
value := explanationConcurrency{}
|
value := explanationConcurrency{}
|
||||||
value.Transcription.Concurrency = 4
|
value.Transcription.Concurrency = 4
|
||||||
@@ -44,11 +44,17 @@ func TestExplainShowsDefaultBaseAndEffectiveProfileValue(t *testing.T) {
|
|||||||
if got := explanationValues(explanation); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n"}) {
|
if got := explanationValues(explanation); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n"}) {
|
||||||
t.Fatalf("history values = %#v", got)
|
t.Fatalf("history values = %#v", got)
|
||||||
}
|
}
|
||||||
if explanation.Effective.YAML != "1\n" || explanation.Origin.Layer != LayerProfile ||
|
if explanation.Effective.YAML != "1\n" || explanation.Origin.Layer != LayerOverlay ||
|
||||||
len(explanation.Origin.Locations) != 1 || explanation.Origin.Locations[0].SourceID != "source-3" ||
|
len(explanation.Origin.Locations) != 1 || explanation.Origin.Locations[0].SourceID != "source-3" ||
|
||||||
explanation.Origin.Locations[0].Line != 2 {
|
explanation.Origin.Locations[0].Line != 2 {
|
||||||
t.Fatalf("effective explanation = %#v", explanation)
|
t.Fatalf("effective explanation = %#v", explanation)
|
||||||
}
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := result.WriteExplanation(&rendered, Keys("transcription", "concurrency")); err != nil ||
|
||||||
|
!strings.Contains(rendered.String(), `layer="overlay"`) ||
|
||||||
|
!strings.Contains(rendered.String(), `label="overlays/testing.yml"`) {
|
||||||
|
t.Fatalf("rendered explanation = %v\n%s", err, rendered.String())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type explanationConfig struct {
|
type explanationConfig struct {
|
||||||
@@ -70,18 +76,18 @@ func TestExplainReplaysCLIResolutionContainersAndSafeHistoricalValues(t *testing
|
|||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "config.yml", `concurrency: 8
|
mainPath := writeImportFile(t, directory, "config.yml", `concurrency: 8
|
||||||
equal: same
|
equal: same
|
||||||
limit: wrong-before-profile
|
limit: wrong-before-overlay
|
||||||
items: [base, removed]
|
items: [base, removed]
|
||||||
labels: {base: retained}
|
labels: {base: retained}
|
||||||
dynamic: {retired: HISTORICAL_EXPLAIN_CANARY, public: visible}
|
dynamic: {retired: HISTORICAL_EXPLAIN_CANARY, public: visible}
|
||||||
credential: APP_SECRET
|
credential: APP_SECRET
|
||||||
classified: APP_SECRET
|
classified: APP_SECRET
|
||||||
`)
|
`)
|
||||||
writeImportFile(t, directory, filepath.Join("profiles", "testing.yml"), `concurrency: 1
|
writeImportFile(t, directory, filepath.Join("overlays", "testing.yml"), `concurrency: 1
|
||||||
equal: same
|
equal: same
|
||||||
limit: 7
|
limit: 7
|
||||||
items: [profile]
|
items: [overlay]
|
||||||
labels: {profile: retained}
|
labels: {overlay: retained}
|
||||||
dynamic: selected
|
dynamic: selected
|
||||||
`)
|
`)
|
||||||
result, err := testLoadWithSecretLookup(File(mainPath), func(name string) (string, bool) {
|
result, err := testLoadWithSecretLookup(File(mainPath), func(name string) (string, bool) {
|
||||||
@@ -90,7 +96,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
return "RESOLVED_EXPLAIN_CANARY", true
|
return "RESOLVED_EXPLAIN_CANARY", true
|
||||||
}, Options[explanationConfig]{
|
}, Options[explanationConfig]{
|
||||||
Profile: "testing",
|
Overlay: "testing",
|
||||||
Overrides: []Override{
|
Overrides: []Override{
|
||||||
{Path: Keys("concurrency"), Value: 2, Flag: "--concurrency"},
|
{Path: Keys("concurrency"), Value: 2, Flag: "--concurrency"},
|
||||||
{Path: Keys("equal"), Value: "same", Flag: "--equal"},
|
{Path: Keys("equal"), Value: "same", Flag: "--equal"},
|
||||||
@@ -130,7 +136,7 @@ dynamic: selected
|
|||||||
if got := explanationValues(concurrency); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n", "2\n", "3\n"}) {
|
if got := explanationValues(concurrency); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n", "2\n", "3\n"}) {
|
||||||
t.Fatalf("concurrency history = %#v", got)
|
t.Fatalf("concurrency history = %#v", got)
|
||||||
}
|
}
|
||||||
if got := historyValueLayers(concurrency); !reflect.DeepEqual(got, []Layer{LayerDefault, LayerBase, LayerProfile, LayerCLI, LayerResolution}) {
|
if got := historyValueLayers(concurrency); !reflect.DeepEqual(got, []Layer{LayerDefault, LayerBase, LayerOverlay, LayerCLI, LayerResolution}) {
|
||||||
t.Fatalf("concurrency layers = %#v", got)
|
t.Fatalf("concurrency layers = %#v", got)
|
||||||
}
|
}
|
||||||
if concurrency.History[4].Before.YAML != "2\n" || concurrency.History[4].Reasons[0] != "normalized\nconcurrency" ||
|
if concurrency.History[4].Before.YAML != "2\n" || concurrency.History[4].Reasons[0] != "normalized\nconcurrency" ||
|
||||||
@@ -149,7 +155,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
|
|
||||||
limit, _ := result.Explain(Keys("limit"))
|
limit, _ := result.Explain(Keys("limit"))
|
||||||
if got := explanationValues(limit); !reflect.DeepEqual(got, []string{"0\n", "wrong-before-profile\n", "7\n"}) {
|
if got := explanationValues(limit); !reflect.DeepEqual(got, []string{"0\n", "wrong-before-overlay\n", "7\n"}) {
|
||||||
t.Fatalf("overridden invalid input was not retained: %#v", got)
|
t.Fatalf("overridden invalid input was not retained: %#v", got)
|
||||||
}
|
}
|
||||||
removed, ok := result.Explain(Keys("dynamic", "retired"))
|
removed, ok := result.Explain(Keys("dynamic", "retired"))
|
||||||
@@ -182,7 +188,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
labels, _ := result.Explain(Keys("labels"))
|
labels, _ := result.Explain(Keys("labels"))
|
||||||
if len(labels.History) != 4 || !strings.Contains(labels.Effective.YAML, "default: retained") ||
|
if len(labels.History) != 4 || !strings.Contains(labels.Effective.YAML, "default: retained") ||
|
||||||
!strings.Contains(labels.Effective.YAML, "profile: retained") || !strings.Contains(labels.Effective.YAML, "cli: retained") {
|
!strings.Contains(labels.Effective.YAML, "overlay: retained") || !strings.Contains(labels.Effective.YAML, "cli: retained") {
|
||||||
t.Fatalf("composite mapping history = %#v", labels)
|
t.Fatalf("composite mapping history = %#v", labels)
|
||||||
}
|
}
|
||||||
if labels.Origin.Layer != LayerCLI || len(labels.Origin.Locations) != 3 {
|
if labels.Origin.Layer != LayerCLI || len(labels.Origin.Locations) != 3 {
|
||||||
@@ -258,7 +264,7 @@ dynamic: selected
|
|||||||
var invalidInput bytes.Buffer
|
var invalidInput bytes.Buffer
|
||||||
if err := result.WriteExplanation(&invalidInput, Keys("limit")); err != nil ||
|
if err := result.WriteExplanation(&invalidInput, Keys("limit")); err != nil ||
|
||||||
!strings.Contains(invalidInput.String(), "policy-validated input") ||
|
!strings.Contains(invalidInput.String(), "policy-validated input") ||
|
||||||
strings.Contains(invalidInput.String(), "wrong-before-profile\n source: layer=\"base\"\n before (canonical typed)") {
|
strings.Contains(invalidInput.String(), "wrong-before-overlay\n source: layer=\"base\"\n before (canonical typed)") {
|
||||||
t.Fatalf("historical representation rendering = %v\n%s", err, invalidInput.String())
|
t.Fatalf("historical representation rendering = %v\n%s", err, invalidInput.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -340,8 +346,8 @@ func TestExplanationReconcilesDefaultsAfterInputReplacement(t *testing.T) {
|
|||||||
if cli {
|
if cli {
|
||||||
opts.Overrides = []Override{{Path: Keys("m"), Value: map[string]any{"b": 2}, Flag: "--m"}}
|
opts.Overrides = []Override{{Path: Keys("m"), Value: map[string]any{"b": 2}, Flag: "--m"}}
|
||||||
} else {
|
} else {
|
||||||
writeImportFile(t, root, "profiles/p.yml", "m: {b: 2}\n")
|
writeImportFile(t, root, "overlays/p.yml", "m: {b: 2}\n")
|
||||||
opts.Profile = "p"
|
opts.Overlay = "p"
|
||||||
}
|
}
|
||||||
result, err := testLoad(File(main), opts)
|
result, err := testLoad(File(main), opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -229,11 +229,11 @@ func TestGlobTraversalBoundsNonmatchesAndAcceptedCandidates(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFilesystemContextIsValidatedWithoutImportsOrActiveProfile(t *testing.T) {
|
func TestFilesystemContextIsValidatedWithoutImportsOrActiveOverlay(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "items: {root: root}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "items: {root: root}\n")
|
||||||
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{
|
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{
|
||||||
Profile: "default", Filesystem: &FilesystemContext{Root: directory},
|
Overlay: "default", Filesystem: &FilesystemContext{Root: directory},
|
||||||
})
|
})
|
||||||
if err != nil || result.Config.Items["root"] != "root" {
|
if err != nil || result.Config.Items["root"] != "root" {
|
||||||
t.Fatalf("file filesystem context = %#v, %v", result, err)
|
t.Fatalf("file filesystem context = %#v, %v", result, err)
|
||||||
@@ -247,9 +247,9 @@ func TestFilesystemContextIsValidatedWithoutImportsOrActiveProfile(t *testing.T)
|
|||||||
t.Fatalf("byte filesystem context = %#v, %v", result, err)
|
t.Fatalf("byte filesystem context = %#v, %v", result, err)
|
||||||
}
|
}
|
||||||
requireLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[importTestConfig]{Filesystem: &FilesystemContext{BaseDir: directory}}, CodeOptionsInvalid)
|
requireLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[importTestConfig]{Filesystem: &FilesystemContext{BaseDir: directory}}, CodeOptionsInvalid)
|
||||||
defaultsOnly, err := testLoad[importTestConfig](NoSource(), Options[importTestConfig]{Profile: "default"})
|
defaultsOnly, err := testLoad[importTestConfig](NoSource(), Options[importTestConfig]{Overlay: "default"})
|
||||||
if err != nil || defaultsOnly == nil {
|
if err != nil || defaultsOnly == nil {
|
||||||
t.Fatalf("default profile with NoSource = %#v, %v", defaultsOnly, err)
|
t.Fatalf("default overlay with NoSource = %#v, %v", defaultsOnly, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
|
if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
|
||||||
|
|||||||
@@ -89,6 +89,18 @@ settings:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadImportsFromProfilesDirectoryAsBaseInput(t *testing.T) {
|
||||||
|
directory := t.TempDir()
|
||||||
|
mainPath := writeImportFile(t, directory, "main.yml", "configkit: {imports: [{path: profiles/shared.yml}]}\n")
|
||||||
|
writeImportFile(t, directory, "profiles/shared.yml", "settings: {root: imported}\n")
|
||||||
|
|
||||||
|
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{Imports: true})
|
||||||
|
if err != nil || result.Config.Settings.Root != "imported" || len(result.Sources()) != 2 ||
|
||||||
|
result.Sources()[1].Layer != LayerBase {
|
||||||
|
t.Fatalf("profiles import = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadRejectsImportConflictsAndFragmentVersions(t *testing.T) {
|
func TestLoadRejectsImportConflictsAndFragmentVersions(t *testing.T) {
|
||||||
t.Run("all duplicate claimants", func(t *testing.T) {
|
t.Run("all duplicate claimants", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
|
|||||||
@@ -19,17 +19,17 @@ type Definition[T any] struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Options contains the application definition and per-load input selections.
|
// Options contains the application definition and per-load input selections.
|
||||||
// Imports enables explicit path and glob imports; Profile selects one fixed profile
|
// Imports enables explicit path and glob imports; Overlay selects one fixed overlay;
|
||||||
// overlay; Overrides contains only values explicitly supplied by an application CLI.
|
// Overrides contains only values explicitly supplied by an application CLI.
|
||||||
type Options[T any] struct {
|
type Options[T any] struct {
|
||||||
Definition Definition[T]
|
Definition Definition[T]
|
||||||
Imports bool
|
Imports bool
|
||||||
Profile string
|
Overlay string
|
||||||
Filesystem *FilesystemContext
|
Filesystem *FilesystemContext
|
||||||
Overrides []Override
|
Overrides []Override
|
||||||
}
|
}
|
||||||
|
|
||||||
// FilesystemContext supplies filesystem roots for imports and profiles.
|
// FilesystemContext supplies filesystem roots for imports and overlays.
|
||||||
type FilesystemContext struct {
|
type FilesystemContext struct {
|
||||||
BaseDir string
|
BaseDir string
|
||||||
Root string
|
Root string
|
||||||
@@ -113,7 +113,7 @@ func (r *Inspection) Diagnostics() []Diagnostic {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
||||||
// imports, and one selected profile. It accepts at most one Options value and
|
// imports, and one selected overlay. It accepts at most one Options value and
|
||||||
// returns no result when any error is reported.
|
// returns no result when any error is reported.
|
||||||
func Load[T any](source Source, secrets SecretBinding, supplied ...Options[T]) (*Loaded[T], error) {
|
func Load[T any](source Source, secrets SecretBinding, supplied ...Options[T]) (*Loaded[T], error) {
|
||||||
return loadWithSecretLookup(source, secrets, os.LookupEnv, supplied...)
|
return loadWithSecretLookup(source, secrets, os.LookupEnv, supplied...)
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ func assembleBaseInput[T any](source Source, options Options[T]) (assembledInput
|
|||||||
input.document = input.composition.root
|
input.document = input.composition.root
|
||||||
} else {
|
} else {
|
||||||
input.sources = sourceInfos(parsed.source)
|
input.sources = sourceInfos(parsed.source)
|
||||||
if options.Filesystem != nil && !activeProfile(options.Profile) {
|
if options.Filesystem != nil && !activeOverlay(options.Overlay) {
|
||||||
if diagnostic := validateFilesystemContext(source, options.Filesystem, parsed); diagnostic != nil {
|
if diagnostic := validateFilesystemContext(source, options.Filesystem, parsed); diagnostic != nil {
|
||||||
return input, []Diagnostic{*diagnostic}
|
return input, []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
@@ -40,17 +40,17 @@ func assembleBaseInput[T any](source Source, options Options[T]) (assembledInput
|
|||||||
}
|
}
|
||||||
|
|
||||||
func applyInputLayers[T any](source Source, options Options[T], input assembledInput) (assembledInput, []Diagnostic) {
|
func applyInputLayers[T any](source Source, options Options[T], input assembledInput) (assembledInput, []Diagnostic) {
|
||||||
if !activeProfile(options.Profile) && len(options.Overrides) == 0 {
|
if !activeOverlay(options.Overlay) && len(options.Overrides) == 0 {
|
||||||
return input, nil
|
return input, nil
|
||||||
}
|
}
|
||||||
composition, diagnostics := compositionForInput(input)
|
composition, diagnostics := compositionForInput(input)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
if activeProfile(options.Profile) {
|
if activeOverlay(options.Overlay) {
|
||||||
composition, input.sources, diagnostics = loadProfileDocument(
|
composition, input.sources, diagnostics = loadSelectedOverlayDocument(
|
||||||
source, options.Filesystem, input.parsed, composition, input.sources,
|
source, options.Filesystem, input.parsed, composition, input.sources,
|
||||||
options.Profile, options.Definition.Version, defaultImportLimits(),
|
options.Overlay, options.Definition.Version, defaultImportLimits(),
|
||||||
)
|
)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
@@ -69,7 +69,7 @@ func applyInputLayers[T any](source Source, options Options[T], input assembledI
|
|||||||
return input, nil
|
return input, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// compositionForInput initializes one handoff for profiles and CLI, including
|
// compositionForInput initializes one handoff for overlays and CLI, including
|
||||||
// defaults-only CLI input. Raw source bytes and mapping keys retain their budgets.
|
// defaults-only CLI input. Raw source bytes and mapping keys retain their budgets.
|
||||||
func compositionForInput(input assembledInput) (*composedDocument, []Diagnostic) {
|
func compositionForInput(input assembledInput) (*composedDocument, []Diagnostic) {
|
||||||
if input.composition != nil {
|
if input.composition != nil {
|
||||||
|
|||||||
@@ -60,8 +60,8 @@ func TestHistoricalPathsExposeHiddenBaseOwnershipWithoutResolvingBaseSecrets(t *
|
|||||||
root := writeImportFile(t, dir, "main.yml", "configkit:\n imports: [{path: first.yml}, {path: second.yml}]\ncredential: CONFIGKIT_HISTORY_UNUSED_PROD_KEY\n")
|
root := writeImportFile(t, dir, "main.yml", "configkit:\n imports: [{path: first.yml}, {path: second.yml}]\ncredential: CONFIGKIT_HISTORY_UNUSED_PROD_KEY\n")
|
||||||
writeImportFile(t, dir, "first.yml", "definitions: {recap: {prompt: recap}}\n")
|
writeImportFile(t, dir, "first.yml", "definitions: {recap: {prompt: recap}}\n")
|
||||||
writeImportFile(t, dir, "second.yml", "definitions: {recap: {output: recap.md}}\n")
|
writeImportFile(t, dir, "second.yml", "definitions: {recap: {output: recap.md}}\n")
|
||||||
writeImportFile(t, dir, "profiles/testing.yml", "definitions: null\ncredential: "+credential+"\n")
|
writeImportFile(t, dir, "overlays/testing.yml", "definitions: null\ncredential: "+credential+"\n")
|
||||||
result, err := testLoad[config](File(root), Options[config]{Imports: true, Profile: "testing"})
|
result, err := testLoad[config](File(root), Options[config]{Imports: true, Overlay: "testing"})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ func selectOptions[T any](source Source, supplied []Options[T]) (Options[T], []D
|
|||||||
}
|
}
|
||||||
var diagnostics []Diagnostic
|
var diagnostics []Diagnostic
|
||||||
definition := options.Definition
|
definition := options.Definition
|
||||||
if !validProfileName(options.Profile) {
|
if !validOverlayName(options.Overlay) {
|
||||||
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "profile name must contain only ASCII letters, digits, underscore, or hyphen"))
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "overlay name must contain only ASCII letters, digits, underscore, or hyphen"))
|
||||||
}
|
}
|
||||||
if options.Filesystem != nil {
|
if options.Filesystem != nil {
|
||||||
diagnostics = append(diagnostics, filesystemOptionDiagnostics(source, options.Filesystem)...)
|
diagnostics = append(diagnostics, filesystemOptionDiagnostics(source, options.Filesystem)...)
|
||||||
@@ -19,11 +19,11 @@ func selectOptions[T any](source Source, supplied []Options[T]) (Options[T], []D
|
|||||||
if source.kind == sourceNone && options.Imports {
|
if source.kind == sourceNone && options.Imports {
|
||||||
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "NoSource cannot enable imports"))
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "NoSource cannot enable imports"))
|
||||||
}
|
}
|
||||||
if source.kind == sourceNone && options.Profile != "" && options.Profile != "default" {
|
if source.kind == sourceNone && options.Overlay != "" && options.Overlay != "default" {
|
||||||
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "NoSource cannot select an active profile"))
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "NoSource cannot select an active overlay"))
|
||||||
}
|
}
|
||||||
if options.Filesystem == nil && (source.kind == sourceBytes || source.kind == sourceReader) && (options.Imports || activeProfile(options.Profile)) {
|
if options.Filesystem == nil && (source.kind == sourceBytes || source.kind == sourceReader) && (options.Imports || activeOverlay(options.Overlay)) {
|
||||||
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "byte and reader imports or profiles require filesystem context"))
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "byte and reader imports or overlays require filesystem context"))
|
||||||
}
|
}
|
||||||
if definition.Version != nil {
|
if definition.Version != nil {
|
||||||
if !definition.Version.Path.valid() {
|
if !definition.Version.Path.valid() {
|
||||||
|
|||||||
@@ -20,14 +20,14 @@ type displacedDefinition struct {
|
|||||||
func overlayDocuments(base *composedDocument, overlay *document.Node) (*composedDocument, []Diagnostic) {
|
func overlayDocuments(base *composedDocument, overlay *document.Node) (*composedDocument, []Diagnostic) {
|
||||||
if base == nil || base.root == nil || base.root.Kind != document.Mapping || overlay == nil || overlay.Kind != document.Mapping {
|
if base == nil || base.root == nil || base.root.Kind != document.Mapping || overlay == nil || overlay.Kind != document.Mapping {
|
||||||
return nil, []Diagnostic{{
|
return nil, []Diagnostic{{
|
||||||
Code: CodeProfileInvalid, Severity: SeverityError,
|
Code: CodeOverlayInvalid, Severity: SeverityError,
|
||||||
Message: "profile overlay requires mapping document roots",
|
Message: "overlay requires mapping document roots",
|
||||||
}}
|
}}
|
||||||
}
|
}
|
||||||
result := cloneComposedDocument(base)
|
result := cloneComposedDocument(base)
|
||||||
mergeOverlayOrigin(result.origins, Path{}, overlay.Location, LayerProfile)
|
mergeOverlayOrigin(result.origins, Path{}, overlay.Location, LayerOverlay)
|
||||||
mergeOverlayMappings(result, result.root, overlay, Path{}, LayerProfile, true)
|
mergeOverlayMappings(result, result.root, overlay, Path{}, LayerOverlay, true)
|
||||||
result.applications = append(result.applications, historyApplication{layer: LayerProfile, value: overlay})
|
result.applications = append(result.applications, historyApplication{layer: LayerOverlay, value: overlay})
|
||||||
return result, nil
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ to_scalar: {child: old}
|
|||||||
}
|
}
|
||||||
overlay := parseCompositionDocument(t, "source-2", `shared:
|
overlay := parseCompositionDocument(t, "source-2", `shared:
|
||||||
changed: new
|
changed: new
|
||||||
added: profile
|
added: overlay
|
||||||
sequence: []
|
sequence: []
|
||||||
nullable: null
|
nullable: null
|
||||||
to_map: {child: new}
|
to_map: {child: new}
|
||||||
@@ -42,7 +42,7 @@ to_scalar: scalar
|
|||||||
}{
|
}{
|
||||||
{path: Keys("shared", "kept"), kind: document.String, text: "base"},
|
{path: Keys("shared", "kept"), kind: document.String, text: "base"},
|
||||||
{path: Keys("shared", "changed"), kind: document.String, text: "new"},
|
{path: Keys("shared", "changed"), kind: document.String, text: "new"},
|
||||||
{path: Keys("shared", "added"), kind: document.String, text: "profile"},
|
{path: Keys("shared", "added"), kind: document.String, text: "overlay"},
|
||||||
{path: Keys("sequence"), kind: document.Sequence},
|
{path: Keys("sequence"), kind: document.Sequence},
|
||||||
{path: Keys("nullable"), kind: document.Null},
|
{path: Keys("nullable"), kind: document.Null},
|
||||||
{path: Keys("to_map"), kind: document.Mapping},
|
{path: Keys("to_map"), kind: document.Mapping},
|
||||||
@@ -62,7 +62,7 @@ to_scalar: scalar
|
|||||||
t.Fatal("parent replacement retained a stale child origin")
|
t.Fatal("parent replacement retained a stale child origin")
|
||||||
}
|
}
|
||||||
shared := result.origins["/shared"]
|
shared := result.origins["/shared"]
|
||||||
if shared.Layer != LayerProfile || len(shared.Locations) != 2 {
|
if shared.Layer != LayerOverlay || len(shared.Locations) != 2 {
|
||||||
t.Fatalf("shared mapping origin = %#v", shared)
|
t.Fatalf("shared mapping origin = %#v", shared)
|
||||||
}
|
}
|
||||||
if len(result.overlays) != 5 {
|
if len(result.overlays) != 5 {
|
||||||
|
|||||||
@@ -41,9 +41,9 @@ func TestOverridesRunAtHighestInputPrecedenceBeforeResolutionAndValidation(t *te
|
|||||||
labels: {base: retained}
|
labels: {base: retained}
|
||||||
api_key: BASE_SECRET
|
api_key: BASE_SECRET
|
||||||
`)
|
`)
|
||||||
writeImportFile(t, directory, filepath.Join("profiles", "testing.yml"), `settings:
|
writeImportFile(t, directory, filepath.Join("overlays", "testing.yml"), `settings:
|
||||||
target: profile
|
target: overlay
|
||||||
labels: {profile: retained}
|
labels: {overlay: retained}
|
||||||
`)
|
`)
|
||||||
validated := false
|
validated := false
|
||||||
overrides := []Override{
|
overrides := []Override{
|
||||||
@@ -62,7 +62,7 @@ func TestOverridesRunAtHighestInputPrecedenceBeforeResolutionAndValidation(t *te
|
|||||||
}
|
}
|
||||||
return "credential-value", true
|
return "credential-value", true
|
||||||
}, Options[overrideLifecycleConfig]{
|
}, Options[overrideLifecycleConfig]{
|
||||||
Imports: true, Profile: "testing", Overrides: overrides,
|
Imports: true, Overlay: "testing", Overrides: overrides,
|
||||||
Definition: Definition[overrideLifecycleConfig]{
|
Definition: Definition[overrideLifecycleConfig]{
|
||||||
Defaults: func() overrideLifecycleConfig {
|
Defaults: func() overrideLifecycleConfig {
|
||||||
return overrideLifecycleConfig{Settings: overrideLifecycleSettings{Target: "default", Count: 9, Text: "default", Items: []string{"default"}}}
|
return overrideLifecycleConfig{Settings: overrideLifecycleSettings{Target: "default", Count: 9, Text: "default", Items: []string{"default"}}}
|
||||||
@@ -86,7 +86,7 @@ func TestOverridesRunAtHighestInputPrecedenceBeforeResolutionAndValidation(t *te
|
|||||||
t.Fatalf("testLoadWithSecretLookup() error = %v", err)
|
t.Fatalf("testLoadWithSecretLookup() error = %v", err)
|
||||||
}
|
}
|
||||||
want := overrideLifecycleSettings{
|
want := overrideLifecycleSettings{
|
||||||
Target: "cli", Labels: map[string]string{"base": "retained", "profile": "retained", "cli": "selected"},
|
Target: "cli", Labels: map[string]string{"base": "retained", "overlay": "retained", "cli": "selected"},
|
||||||
APIKey: result.Config.Settings.APIKey,
|
APIKey: result.Config.Settings.APIKey,
|
||||||
}
|
}
|
||||||
if !validated || result.Config.Settings.Count != 0 || result.Config.Settings.Enabled || result.Config.Settings.Text != "" ||
|
if !validated || result.Config.Settings.Count != 0 || result.Config.Settings.Enabled || result.Config.Settings.Text != "" ||
|
||||||
@@ -95,7 +95,7 @@ func TestOverridesRunAtHighestInputPrecedenceBeforeResolutionAndValidation(t *te
|
|||||||
t.Fatalf("effective settings = %#v", result.Config.Settings)
|
t.Fatalf("effective settings = %#v", result.Config.Settings)
|
||||||
}
|
}
|
||||||
sources := result.Sources()
|
sources := result.Sources()
|
||||||
if len(sources) != 3+len(overrides) || sources[0].Layer != LayerBase || sources[1].Layer != LayerBase || sources[2].Layer != LayerProfile {
|
if len(sources) != 3+len(overrides) || sources[0].Layer != LayerBase || sources[1].Layer != LayerBase || sources[2].Layer != LayerOverlay {
|
||||||
t.Fatalf("sources = %#v", sources)
|
t.Fatalf("sources = %#v", sources)
|
||||||
}
|
}
|
||||||
for index, override := range overrides {
|
for index, override := range overrides {
|
||||||
@@ -104,7 +104,7 @@ func TestOverridesRunAtHighestInputPrecedenceBeforeResolutionAndValidation(t *te
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
history := result.Metadata().History(Keys("settings", "target"))
|
history := result.Metadata().History(Keys("settings", "target"))
|
||||||
wantLayers := []Layer{LayerDefault, LayerBase, LayerProfile, LayerCLI, LayerResolution}
|
wantLayers := []Layer{LayerDefault, LayerBase, LayerOverlay, LayerCLI, LayerResolution}
|
||||||
if got := historyLayers(history); !reflect.DeepEqual(got, wantLayers) {
|
if got := historyLayers(history); !reflect.DeepEqual(got, wantLayers) {
|
||||||
t.Fatalf("target history layers = %#v, want %#v; history %#v", got, wantLayers, history)
|
t.Fatalf("target history layers = %#v, want %#v; history %#v", got, wantLayers, history)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ type layeredConfig struct {
|
|||||||
Shared struct {
|
Shared struct {
|
||||||
Equal string `yaml:"equal"`
|
Equal string `yaml:"equal"`
|
||||||
Imported string `yaml:"imported"`
|
Imported string `yaml:"imported"`
|
||||||
Profile string `yaml:"profile"`
|
Overlay string `yaml:"overlay"`
|
||||||
} `yaml:"shared"`
|
} `yaml:"shared"`
|
||||||
Values []int `yaml:"values"`
|
Values []int `yaml:"values"`
|
||||||
Items map[string]layeredItem `yaml:"items"`
|
Items map[string]layeredItem `yaml:"items"`
|
||||||
@@ -40,7 +40,7 @@ nullable: base
|
|||||||
empty: {}
|
empty: {}
|
||||||
`)
|
`)
|
||||||
importPath := writeImportFile(t, directory, "imported.yml", "shared: {imported: base}\n")
|
importPath := writeImportFile(t, directory, "imported.yml", "shared: {imported: base}\n")
|
||||||
profilePath := writeImportFile(t, directory, "profiles/testing.yml", `shared: {profile: selected}
|
overlayPath := writeImportFile(t, directory, "overlays/testing.yml", `shared: {overlay: selected}
|
||||||
values: [3, 4]
|
values: [3, 4]
|
||||||
value: selected
|
value: selected
|
||||||
nullable: null
|
nullable: null
|
||||||
@@ -71,23 +71,23 @@ empty: {}
|
|||||||
}
|
}
|
||||||
|
|
||||||
result, err := testLoad[layeredConfig](File(mainPath), Options[layeredConfig]{
|
result, err := testLoad[layeredConfig](File(mainPath), Options[layeredConfig]{
|
||||||
Imports: true, Profile: "testing", Definition: definition,
|
Imports: true, Overlay: "testing", Definition: definition,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
var loadError *LoadError
|
var loadError *LoadError
|
||||||
_ = errors.As(err, &loadError)
|
_ = errors.As(err, &loadError)
|
||||||
t.Fatalf("%v: %#v", err, loadError.Diagnostics())
|
t.Fatalf("%v: %#v", err, loadError.Diagnostics())
|
||||||
}
|
}
|
||||||
wantSources := []string{canonicalTestPath(t, mainPath), canonicalTestPath(t, importPath), canonicalTestPath(t, profilePath)}
|
wantSources := []string{canonicalTestPath(t, mainPath), canonicalTestPath(t, importPath), canonicalTestPath(t, overlayPath)}
|
||||||
sources := result.Sources()
|
sources := result.Sources()
|
||||||
gotSources := make([]string, len(sources))
|
gotSources := make([]string, len(sources))
|
||||||
for index, source := range sources {
|
for index, source := range sources {
|
||||||
gotSources[index] = source.Path
|
gotSources[index] = source.Path
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(gotSources, wantSources) || sources[2].Layer != LayerProfile {
|
if !reflect.DeepEqual(gotSources, wantSources) || sources[2].Layer != LayerOverlay {
|
||||||
t.Fatalf("sources = %#v", sources)
|
t.Fatalf("sources = %#v", sources)
|
||||||
}
|
}
|
||||||
if result.Config.Shared.Equal != "same" || result.Config.Shared.Imported != "base" || result.Config.Shared.Profile != "selected" ||
|
if result.Config.Shared.Equal != "same" || result.Config.Shared.Imported != "base" || result.Config.Shared.Overlay != "selected" ||
|
||||||
!reflect.DeepEqual(result.Config.Values, []int{5}) || result.Config.Nullable != nil || result.Config.Derived != 7 ||
|
!reflect.DeepEqual(result.Config.Values, []int{5}) || result.Config.Nullable != nil || result.Config.Derived != 7 ||
|
||||||
result.Config.Empty["retained"] != "default" {
|
result.Config.Empty["retained"] != "default" {
|
||||||
t.Fatalf("configuration = %#v", result.Config)
|
t.Fatalf("configuration = %#v", result.Config)
|
||||||
@@ -100,13 +100,13 @@ empty: {}
|
|||||||
empty, _ := metadata.Lookup(Keys("empty"))
|
empty, _ := metadata.Lookup(Keys("empty"))
|
||||||
firstValue, _ := metadata.Lookup(Keys("values").Index(0))
|
firstValue, _ := metadata.Lookup(Keys("values").Index(0))
|
||||||
if !equal.Explicit || equal.Origin.Layer != LayerBase || derived.Explicit || derived.Origin.Operation != ChangeDerivedDefault ||
|
if !equal.Explicit || equal.Origin.Layer != LayerBase || derived.Explicit || derived.Origin.Operation != ChangeDerivedDefault ||
|
||||||
!nullable.Explicit || !nullable.Null || nullable.Origin.Layer != LayerProfile ||
|
!nullable.Explicit || !nullable.Null || nullable.Origin.Layer != LayerOverlay ||
|
||||||
!empty.Explicit || empty.Origin.Layer != LayerProfile || len(empty.Origin.Locations) != 2 ||
|
!empty.Explicit || empty.Origin.Layer != LayerOverlay || len(empty.Origin.Locations) != 2 ||
|
||||||
!firstValue.Explicit || firstValue.Origin.Operation != ChangeNormalization {
|
!firstValue.Explicit || firstValue.Origin.Operation != ChangeNormalization {
|
||||||
t.Fatalf("metadata = equal %#v derived %#v nullable %#v empty %#v value %#v", equal, derived, nullable, empty, firstValue)
|
t.Fatalf("metadata = equal %#v derived %#v nullable %#v empty %#v value %#v", equal, derived, nullable, empty, firstValue)
|
||||||
}
|
}
|
||||||
if _, ok := metadata.Lookup(Keys("value", "child")); ok {
|
if _, ok := metadata.Lookup(Keys("value", "child")); ok {
|
||||||
t.Fatal("profile-removed child remains effective")
|
t.Fatal("overlay-removed child remains effective")
|
||||||
}
|
}
|
||||||
if _, ok := metadata.Lookup(Keys("values").Index(1)); ok {
|
if _, ok := metadata.Lookup(Keys("values").Index(1)); ok {
|
||||||
t.Fatal("resolution-removed sequence index remains effective")
|
t.Fatal("resolution-removed sequence index remains effective")
|
||||||
@@ -116,10 +116,10 @@ empty: {}
|
|||||||
}
|
}
|
||||||
|
|
||||||
assertHistoryLayersAndPaths(t, metadata.History(Keys("values").Index(1)),
|
assertHistoryLayersAndPaths(t, metadata.History(Keys("values").Index(1)),
|
||||||
[]Layer{LayerDefault, LayerBase, LayerProfile, LayerResolution},
|
[]Layer{LayerDefault, LayerBase, LayerOverlay, LayerResolution},
|
||||||
[]string{"/values/1", "/values/1", "/values", "/values"})
|
[]string{"/values/1", "/values/1", "/values", "/values"})
|
||||||
assertHistoryLayersAndPaths(t, metadata.History(Keys("value", "child")),
|
assertHistoryLayersAndPaths(t, metadata.History(Keys("value", "child")),
|
||||||
[]Layer{LayerDefault, LayerBase, LayerProfile},
|
[]Layer{LayerDefault, LayerBase, LayerOverlay},
|
||||||
[]string{"/value/child", "/value/child", "/value"})
|
[]string{"/value/child", "/value/child", "/value"})
|
||||||
removedHistory := metadata.History(Keys("items", "remove", "value"))
|
removedHistory := metadata.History(Keys("items", "remove", "value"))
|
||||||
assertHistoryLayersAndPaths(t, removedHistory,
|
assertHistoryLayersAndPaths(t, removedHistory,
|
||||||
@@ -159,11 +159,11 @@ empty: {}
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSelectedProfileLoadsRemainIndependentConcurrently(t *testing.T) {
|
func TestSelectedOverlayLoadsRemainIndependentConcurrently(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "values: [1, 2]\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "values: [1, 2]\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "values: [3, 4]\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "values: [3, 4]\n")
|
||||||
options := Options[layeredConfig]{Profile: "testing"}
|
options := Options[layeredConfig]{Overlay: "testing"}
|
||||||
|
|
||||||
const loads = 16
|
const loads = 16
|
||||||
results := make(chan *testResult[layeredConfig], loads)
|
results := make(chan *testResult[layeredConfig], loads)
|
||||||
@@ -200,7 +200,7 @@ func TestSelectedProfileLoadsRemainIndependentConcurrently(t *testing.T) {
|
|||||||
if !reflect.DeepEqual(result.Config.Values, []int{3, 4}) {
|
if !reflect.DeepEqual(result.Config.Values, []int{3, 4}) {
|
||||||
t.Fatalf("concurrent result contaminated = %#v", result.Config.Values)
|
t.Fatalf("concurrent result contaminated = %#v", result.Config.Values)
|
||||||
}
|
}
|
||||||
if info, ok := result.Metadata().Lookup(Keys("values")); !ok || info.Origin.Layer != LayerProfile {
|
if info, ok := result.Metadata().Lookup(Keys("values")); !ok || info.Origin.Layer != LayerOverlay {
|
||||||
t.Fatalf("concurrent metadata contaminated = %#v, %v", info, ok)
|
t.Fatalf("concurrent metadata contaminated = %#v, %v", info, ok)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -220,7 +220,7 @@ sequence: [first, second]
|
|||||||
composite: {first: first}
|
composite: {first: first}
|
||||||
`)
|
`)
|
||||||
secondPath := writeImportFile(t, directory, "second.yml", "composite: {second: second}\n")
|
secondPath := writeImportFile(t, directory, "second.yml", "composite: {second: second}\n")
|
||||||
profilePath := writeImportFile(t, directory, "profiles/testing.yml", "equal: same\nprofile: profile\n")
|
overlayPath := writeImportFile(t, directory, "overlays/testing.yml", "equal: same\noverlay: overlay\n")
|
||||||
compositeSources := map[string]bool{
|
compositeSources := map[string]bool{
|
||||||
canonicalTestPath(t, mainPath): true,
|
canonicalTestPath(t, mainPath): true,
|
||||||
canonicalTestPath(t, firstPath): true,
|
canonicalTestPath(t, firstPath): true,
|
||||||
@@ -232,12 +232,12 @@ composite: {first: first}
|
|||||||
Sequence []string `yaml:"sequence"`
|
Sequence []string `yaml:"sequence"`
|
||||||
Composite map[string]string `yaml:"composite"`
|
Composite map[string]string `yaml:"composite"`
|
||||||
Equal string `yaml:"equal"`
|
Equal string `yaml:"equal"`
|
||||||
Profile string `yaml:"profile"`
|
Overlay string `yaml:"overlay"`
|
||||||
CLIEqual string `yaml:"cli_equal"`
|
CLIEqual string `yaml:"cli_equal"`
|
||||||
}
|
}
|
||||||
var callbackErr error
|
var callbackErr error
|
||||||
result, err := testLoad[config](File(mainPath), Options[config]{
|
result, err := testLoad[config](File(mainPath), Options[config]{
|
||||||
Imports: true, Profile: "testing", Overrides: []Override{{Path: Keys("cli_equal"), Value: "same", Flag: "--cli-equal"}},
|
Imports: true, Overlay: "testing", Overrides: []Override{{Path: Keys("cli_equal"), Value: "same", Flag: "--cli-equal"}},
|
||||||
Definition: Definition[config]{Resolve: func(_ *config, resolution *Resolution) error {
|
Definition: Definition[config]{Resolve: func(_ *config, resolution *Resolution) error {
|
||||||
check := func(ok bool, message string) {
|
check := func(ok bool, message string) {
|
||||||
if !ok && callbackErr == nil {
|
if !ok && callbackErr == nil {
|
||||||
@@ -257,9 +257,9 @@ composite: {first: first}
|
|||||||
fileOwner(Keys("main"), canonicalTestPath(t, mainPath))
|
fileOwner(Keys("main"), canonicalTestPath(t, mainPath))
|
||||||
fileOwner(Keys("imported"), canonicalTestPath(t, firstPath))
|
fileOwner(Keys("imported"), canonicalTestPath(t, firstPath))
|
||||||
fileOwner(Keys("sequence").Index(1), canonicalTestPath(t, firstPath))
|
fileOwner(Keys("sequence").Index(1), canonicalTestPath(t, firstPath))
|
||||||
profile := fileOwner(Keys("equal"), canonicalTestPath(t, profilePath))
|
overlay := fileOwner(Keys("equal"), canonicalTestPath(t, overlayPath))
|
||||||
fileOwner(Keys("profile"), canonicalTestPath(t, profilePath))
|
fileOwner(Keys("overlay"), canonicalTestPath(t, overlayPath))
|
||||||
check(profile.Origin.Layer == LayerProfile, "profile replacement retained base ownership")
|
check(overlay.Origin.Layer == LayerOverlay, "overlay replacement retained base ownership")
|
||||||
cli, found := resolution.InputInfo(Keys("cli_equal"))
|
cli, found := resolution.InputInfo(Keys("cli_equal"))
|
||||||
check(found && cli.Origin.Layer == LayerCLI && len(cli.Origin.Locations) == 1, "CLI replacement lost ownership")
|
check(found && cli.Origin.Layer == LayerCLI && len(cli.Origin.Locations) == 1, "CLI replacement lost ownership")
|
||||||
if found && len(cli.Origin.Locations) == 1 {
|
if found && len(cli.Origin.Locations) == 1 {
|
||||||
@@ -298,7 +298,7 @@ composite: {first: first}
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if result.Config.Main != "main" || result.Config.Imported != "imported" || !reflect.DeepEqual(result.Config.Sequence, []string{"first", "second"}) ||
|
if result.Config.Main != "main" || result.Config.Imported != "imported" || !reflect.DeepEqual(result.Config.Sequence, []string{"first", "second"}) ||
|
||||||
result.Config.Equal != "same" || result.Config.Profile != "profile" || result.Config.CLIEqual != "same" {
|
result.Config.Equal != "same" || result.Config.Overlay != "overlay" || result.Config.CLIEqual != "same" {
|
||||||
t.Fatalf("configuration = %#v", result.Config)
|
t.Fatalf("configuration = %#v", result.Config)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ type Layer string
|
|||||||
const (
|
const (
|
||||||
LayerDefault Layer = "default"
|
LayerDefault Layer = "default"
|
||||||
LayerBase Layer = "base"
|
LayerBase Layer = "base"
|
||||||
LayerProfile Layer = "profile"
|
LayerOverlay Layer = "overlay"
|
||||||
LayerCLI Layer = "cli"
|
LayerCLI Layer = "cli"
|
||||||
LayerResolution Layer = "resolution"
|
LayerResolution Layer = "resolution"
|
||||||
)
|
)
|
||||||
@@ -90,13 +90,13 @@ const (
|
|||||||
CodeImportLimitExceeded Code = "import.limit_exceeded"
|
CodeImportLimitExceeded Code = "import.limit_exceeded"
|
||||||
CodeImportVersion Code = "import.version"
|
CodeImportVersion Code = "import.version"
|
||||||
|
|
||||||
CodeProfileInvalid Code = "profile.invalid"
|
CodeOverlayInvalid Code = "overlay.invalid"
|
||||||
CodeProfileMissing Code = "profile.missing"
|
CodeOverlayMissing Code = "overlay.missing"
|
||||||
CodeProfileOutsideRoot Code = "profile.outside_root"
|
CodeOverlayOutsideRoot Code = "overlay.outside_root"
|
||||||
CodeProfileRepeated Code = "profile.repeated"
|
CodeOverlayRepeated Code = "overlay.repeated"
|
||||||
CodeProfileDirective Code = "profile.directive"
|
CodeOverlayDirective Code = "overlay.directive"
|
||||||
CodeProfileVersion Code = "profile.version"
|
CodeOverlayVersion Code = "overlay.version"
|
||||||
CodeProfileLimitExceeded Code = "profile.limit_exceeded"
|
CodeOverlayLimitExceeded Code = "overlay.limit_exceeded"
|
||||||
|
|
||||||
CodeComposeInvalid Code = "compose.invalid"
|
CodeComposeInvalid Code = "compose.invalid"
|
||||||
CodeComposeConflict Code = "compose.conflict"
|
CodeComposeConflict Code = "compose.conflict"
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ empty_sequence: []
|
|||||||
labels: {hidden: DYNAMIC_CANARY_6a12, public: visible}
|
labels: {hidden: DYNAMIC_CANARY_6a12, public: visible}
|
||||||
sequence: [second, first]
|
sequence: [second, first]
|
||||||
`)
|
`)
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "dynamic: selected\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "dynamic: selected\n")
|
||||||
definition := Definition[renderConfig]{
|
definition := Definition[renderConfig]{
|
||||||
Secret: func(path Path) bool {
|
Secret: func(path Path) bool {
|
||||||
return path.String() == "/labels/hidden" || path.String() == "/dynamic/retired"
|
return path.String() == "/labels/hidden" || path.String() == "/dynamic/retired"
|
||||||
@@ -85,7 +85,7 @@ sequence: [second, first]
|
|||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
result, err := testLoad[renderConfig](File(mainPath), Options[renderConfig]{Definition: definition, Profile: "testing"})
|
result, err := testLoad[renderConfig](File(mainPath), Options[renderConfig]{Definition: definition, Overlay: "testing"})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,12 +12,12 @@ import (
|
|||||||
yamladapter "gitea.maximumdirect.net/eric/ConfigKit/internal/yaml"
|
yamladapter "gitea.maximumdirect.net/eric/ConfigKit/internal/yaml"
|
||||||
)
|
)
|
||||||
|
|
||||||
func activeProfile(name string) bool {
|
func activeOverlay(name string) bool {
|
||||||
return name != "" && name != "default"
|
return name != "" && name != "default"
|
||||||
}
|
}
|
||||||
|
|
||||||
func validProfileName(name string) bool {
|
func validOverlayName(name string) bool {
|
||||||
if !activeProfile(name) {
|
if !activeOverlay(name) {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
for _, character := range name {
|
for _, character := range name {
|
||||||
@@ -31,38 +31,38 @@ func validProfileName(name string) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func loadProfileDocument(source Source, context *FilesystemContext, main parsedSource, base *composedDocument, sources []SourceInfo, name string, rule *VersionRule, limits importLimits) (*composedDocument, []SourceInfo, []Diagnostic) {
|
func loadSelectedOverlayDocument(source Source, context *FilesystemContext, main parsedSource, base *composedDocument, sources []SourceInfo, name string, rule *VersionRule, limits importLimits) (*composedDocument, []SourceInfo, []Diagnostic) {
|
||||||
rootPath, _, _, diagnostic := importFilesystem(source, context, main)
|
rootPath, _, _, diagnostic := importFilesystem(source, context, main)
|
||||||
if diagnostic != nil {
|
if diagnostic != nil {
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{*diagnostic}
|
return nil, cloneSourceInfos(sources), []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
profilePath := filepath.Join(rootPath, "profiles", name+".yml")
|
overlayPath := filepath.Join(rootPath, "overlays", name+".yml")
|
||||||
canonical, err := canonicalExistingPath(profilePath)
|
canonical, err := canonicalExistingPath(overlayPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := CodeProfileInvalid
|
code := CodeOverlayInvalid
|
||||||
message := "selected profile could not be resolved"
|
message := "selected overlay could not be resolved"
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
code, message = CodeProfileMissing, "selected profile does not exist"
|
code, message = CodeOverlayMissing, "selected overlay does not exist"
|
||||||
} else if errors.Is(err, fs.ErrPermission) {
|
} else if errors.Is(err, fs.ErrPermission) {
|
||||||
code, message = CodeImportPermission, "selected profile cannot be accessed"
|
code, message = CodeImportPermission, "selected overlay cannot be accessed"
|
||||||
}
|
}
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(code, message, nil)}
|
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(code, message, nil)}
|
||||||
}
|
}
|
||||||
if !containedPath(rootPath, canonical) {
|
if !containedPath(rootPath, canonical) {
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeProfileOutsideRoot, "selected profile resolves outside the configuration root", nil)}
|
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeOverlayOutsideRoot, "selected overlay resolves outside the configuration root", nil)}
|
||||||
}
|
}
|
||||||
for _, existing := range sources {
|
for _, existing := range sources {
|
||||||
if existing.Path != "" && existing.Path == canonical {
|
if existing.Path != "" && existing.Path == canonical {
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeProfileRepeated, "selected profile is already present in the base source graph", nil)}
|
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeOverlayRepeated, "selected overlay is already present in the base source graph", nil)}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if len(sources)+1 > limits.sources {
|
if len(sources)+1 > limits.sources {
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeProfileLimitExceeded, "selected profile exceeds the source-count limit", nil)}
|
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeOverlayLimitExceeded, "selected overlay exceeds the source-count limit", nil)}
|
||||||
}
|
}
|
||||||
|
|
||||||
root, err := os.OpenRoot(rootPath)
|
root, err := os.OpenRoot(rootPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
value := globFilesystemDiagnostic(err, "configuration root could not be opened for the selected profile", Location{})
|
value := globFilesystemDiagnostic(err, "configuration root could not be opened for the selected overlay", Location{})
|
||||||
value.Primary = nil
|
value.Primary = nil
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{value}
|
return nil, cloneSourceInfos(sources), []Diagnostic{value}
|
||||||
}
|
}
|
||||||
@@ -74,57 +74,57 @@ func loadProfileDocument(source Source, context *FilesystemContext, main parsedS
|
|||||||
}()
|
}()
|
||||||
relative, err := filepath.Rel(rootPath, canonical)
|
relative, err := filepath.Rel(rootPath, canonical)
|
||||||
if err != nil || filepath.IsAbs(relative) || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
if err != nil || filepath.IsAbs(relative) || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
||||||
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeProfileOutsideRoot, "selected profile could not be addressed inside the configuration root", nil)}
|
return nil, cloneSourceInfos(sources), []Diagnostic{importDiagnostic(CodeOverlayOutsideRoot, "selected overlay could not be addressed inside the configuration root", nil)}
|
||||||
}
|
}
|
||||||
|
|
||||||
sourceID := "source-" + strconv.Itoa(len(sources)+1)
|
sourceID := "source-" + strconv.Itoa(len(sources)+1)
|
||||||
profileLocation := &Location{SourceID: sourceID}
|
overlayLocation := &Location{SourceID: sourceID}
|
||||||
profileSource := SourceInfo{ID: sourceID, Label: filepath.ToSlash(filepath.Join("profiles", name+".yml")), Path: canonical, Layer: LayerProfile}
|
overlaySource := SourceInfo{ID: sourceID, Label: filepath.ToSlash(filepath.Join("overlays", name+".yml")), Path: canonical, Layer: LayerOverlay}
|
||||||
sources = append(cloneSourceInfos(sources), profileSource)
|
sources = append(cloneSourceInfos(sources), overlaySource)
|
||||||
data, diagnostic := readProfileFile(root, relative, sourceID, limits.bytes-base.inputBytes)
|
data, diagnostic := readOverlayFile(root, relative, sourceID, limits.bytes-base.inputBytes)
|
||||||
if diagnostic != nil {
|
if diagnostic != nil {
|
||||||
return nil, sources, []Diagnostic{*diagnostic}
|
return nil, sources, []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
profileRoot, issues := yamladapter.Parse(bytes.NewReader(data), sourceID, yamladapter.Limits{Depth: maxDocumentDepth, Nodes: maxDocumentNodes})
|
overlayRoot, issues := yamladapter.Parse(bytes.NewReader(data), sourceID, yamladapter.Limits{Depth: maxDocumentDepth, Nodes: maxDocumentNodes})
|
||||||
if len(issues) != 0 {
|
if len(issues) != 0 {
|
||||||
return nil, sources, parserDiagnostics(sourceID, issues)
|
return nil, sources, parserDiagnostics(sourceID, issues)
|
||||||
}
|
}
|
||||||
nodeCount := countInputNodes(profileRoot)
|
nodeCount := countInputNodes(overlayRoot)
|
||||||
if base.inputNodes+nodeCount > limits.nodes {
|
if base.inputNodes+nodeCount > limits.nodes {
|
||||||
return nil, sources, []Diagnostic{importDiagnostic(CodeProfileLimitExceeded, "selected profile exceeds the aggregate node limit", profileLocation)}
|
return nil, sources, []Diagnostic{importDiagnostic(CodeOverlayLimitExceeded, "selected overlay exceeds the aggregate node limit", overlayLocation)}
|
||||||
}
|
}
|
||||||
if diagnostics := profileDirectiveDiagnostics(profileRoot, Path{}); len(diagnostics) != 0 {
|
if diagnostics := overlayDirectiveDiagnostics(overlayRoot, Path{}); len(diagnostics) != 0 {
|
||||||
return nil, sources, diagnostics
|
return nil, sources, diagnostics
|
||||||
}
|
}
|
||||||
if versionNode := fragmentVersionClaim(profileRoot, rule); versionNode != nil {
|
if versionNode := fragmentVersionClaim(overlayRoot, rule); versionNode != nil {
|
||||||
location := publicLocation(versionNode.Location)
|
location := publicLocation(versionNode.Location)
|
||||||
return nil, sources, []Diagnostic{{
|
return nil, sources, []Diagnostic{{
|
||||||
Code: CodeProfileVersion, Severity: SeverityError, Path: rule.Path.clone(),
|
Code: CodeOverlayVersion, Severity: SeverityError, Path: rule.Path.clone(),
|
||||||
Message: "profiles cannot contribute to or replace the schema-version path", Primary: &location,
|
Message: "overlays cannot contribute to or replace the schema-version path", Primary: &location,
|
||||||
}}
|
}}
|
||||||
}
|
}
|
||||||
closeErr := root.Close()
|
closeErr := root.Close()
|
||||||
rootClosed = true
|
rootClosed = true
|
||||||
if closeErr != nil {
|
if closeErr != nil {
|
||||||
return nil, sources, []Diagnostic{importDiagnostic(CodeImportRead, "configuration root could not be closed after reading the selected profile", nil)}
|
return nil, sources, []Diagnostic{importDiagnostic(CodeImportRead, "configuration root could not be closed after reading the selected overlay", nil)}
|
||||||
}
|
}
|
||||||
|
|
||||||
profiled, diagnostics := overlayDocuments(base, profileRoot)
|
overlayd, diagnostics := overlayDocuments(base, overlayRoot)
|
||||||
if profiled != nil {
|
if overlayd != nil {
|
||||||
profiled.inputBytes = base.inputBytes + int64(len(data))
|
overlayd.inputBytes = base.inputBytes + int64(len(data))
|
||||||
profiled.inputNodes = base.inputNodes + nodeCount
|
overlayd.inputNodes = base.inputNodes + nodeCount
|
||||||
}
|
}
|
||||||
return profiled, sources, diagnostics
|
return overlayd, sources, diagnostics
|
||||||
}
|
}
|
||||||
|
|
||||||
func readProfileFile(root *os.Root, relative, sourceID string, remaining int64) ([]byte, *Diagnostic) {
|
func readOverlayFile(root *os.Root, relative, sourceID string, remaining int64) ([]byte, *Diagnostic) {
|
||||||
limit := min(int64(maxSourceBytes), remaining)
|
limit := min(int64(maxSourceBytes), remaining)
|
||||||
if limit < 0 {
|
if limit < 0 {
|
||||||
limit = 0
|
limit = 0
|
||||||
}
|
}
|
||||||
data, failure := readRegularFile(relative, root.Stat, root.Open, limit)
|
data, failure := readRegularFile(relative, root.Stat, root.Open, limit)
|
||||||
if failure != nil {
|
if failure != nil {
|
||||||
value := sourceReadDiagnostic(failure, sourceID, CodeProfileLimitExceeded, "selected profile exceeds a source or aggregate byte limit")
|
value := sourceReadDiagnostic(failure, sourceID, CodeOverlayLimitExceeded, "selected overlay exceeds a source or aggregate byte limit")
|
||||||
return nil, &value
|
return nil, &value
|
||||||
}
|
}
|
||||||
return data, nil
|
return data, nil
|
||||||
@@ -9,7 +9,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
type profileTestConfig struct {
|
type overlayTestConfig struct {
|
||||||
Settings struct {
|
Settings struct {
|
||||||
Kept string `yaml:"kept"`
|
Kept string `yaml:"kept"`
|
||||||
Changed string `yaml:"changed"`
|
Changed string `yaml:"changed"`
|
||||||
@@ -21,7 +21,7 @@ type profileTestConfig struct {
|
|||||||
Schema map[string]string `yaml:"schema"`
|
Schema map[string]string `yaml:"schema"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadAppliesSelectedProfileAfterBaseAndBeforeDefaults(t *testing.T) {
|
func TestLoadAppliesSelectedOverlayAfterBaseAndBeforeDefaults(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", `configkit:
|
mainPath := writeImportFile(t, directory, "main.yml", `configkit:
|
||||||
imports: [{path: base.yml}]
|
imports: [{path: base.yml}]
|
||||||
@@ -33,19 +33,19 @@ nullable: base
|
|||||||
value: {child: base}
|
value: {child: base}
|
||||||
`)
|
`)
|
||||||
basePath := writeImportFile(t, directory, "base.yml", "settings: {added: imported}\n")
|
basePath := writeImportFile(t, directory, "base.yml", "settings: {added: imported}\n")
|
||||||
profilePath := writeImportFile(t, directory, "profiles/testing.yml", `settings:
|
overlayPath := writeImportFile(t, directory, "overlays/testing.yml", `settings:
|
||||||
changed: profile
|
changed: overlay
|
||||||
values: [profile]
|
values: [overlay]
|
||||||
nullable: null
|
nullable: null
|
||||||
value: scalar
|
value: scalar
|
||||||
`)
|
`)
|
||||||
|
|
||||||
result, err := testLoad[profileTestConfig](File(mainPath), Options[profileTestConfig]{
|
result, err := testLoad[overlayTestConfig](File(mainPath), Options[overlayTestConfig]{
|
||||||
Imports: true,
|
Imports: true,
|
||||||
Profile: "testing",
|
Overlay: "testing",
|
||||||
Definition: Definition[profileTestConfig]{Defaults: func() profileTestConfig {
|
Definition: Definition[overlayTestConfig]{Defaults: func() overlayTestConfig {
|
||||||
defaultValue := "default"
|
defaultValue := "default"
|
||||||
return profileTestConfig{
|
return overlayTestConfig{
|
||||||
Values: []string{"default"}, Nullable: &defaultValue,
|
Values: []string{"default"}, Nullable: &defaultValue,
|
||||||
Settings: struct {
|
Settings: struct {
|
||||||
Kept string `yaml:"kept"`
|
Kept string `yaml:"kept"`
|
||||||
@@ -58,31 +58,31 @@ value: scalar
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if result.Config.Settings.Kept != "main" || result.Config.Settings.Changed != "profile" || result.Config.Settings.Added != "imported" {
|
if result.Config.Settings.Kept != "main" || result.Config.Settings.Changed != "overlay" || result.Config.Settings.Added != "imported" {
|
||||||
t.Fatalf("settings = %#v", result.Config.Settings)
|
t.Fatalf("settings = %#v", result.Config.Settings)
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(result.Config.Values, []string{"profile"}) || result.Config.Nullable != nil || result.Config.Value != "scalar" {
|
if !reflect.DeepEqual(result.Config.Values, []string{"overlay"}) || result.Config.Nullable != nil || result.Config.Value != "scalar" {
|
||||||
t.Fatalf("profile values = values %#v nullable %#v value %#v", result.Config.Values, result.Config.Nullable, result.Config.Value)
|
t.Fatalf("overlay values = values %#v nullable %#v value %#v", result.Config.Values, result.Config.Nullable, result.Config.Value)
|
||||||
}
|
}
|
||||||
sources := result.Sources()
|
sources := result.Sources()
|
||||||
wantPaths := []string{canonicalTestPath(t, mainPath), canonicalTestPath(t, basePath), canonicalTestPath(t, profilePath)}
|
wantPaths := []string{canonicalTestPath(t, mainPath), canonicalTestPath(t, basePath), canonicalTestPath(t, overlayPath)}
|
||||||
gotPaths := make([]string, len(sources))
|
gotPaths := make([]string, len(sources))
|
||||||
for index, source := range sources {
|
for index, source := range sources {
|
||||||
gotPaths[index] = source.Path
|
gotPaths[index] = source.Path
|
||||||
}
|
}
|
||||||
if !reflect.DeepEqual(gotPaths, wantPaths) || sources[2].Layer != LayerProfile {
|
if !reflect.DeepEqual(gotPaths, wantPaths) || sources[2].Layer != LayerOverlay {
|
||||||
t.Fatalf("sources = %#v", sources)
|
t.Fatalf("sources = %#v", sources)
|
||||||
}
|
}
|
||||||
changed, _ := result.Metadata().Lookup(Keys("settings", "changed"))
|
changed, _ := result.Metadata().Lookup(Keys("settings", "changed"))
|
||||||
kept, _ := result.Metadata().Lookup(Keys("settings", "kept"))
|
kept, _ := result.Metadata().Lookup(Keys("settings", "kept"))
|
||||||
if changed.Origin.Layer != LayerProfile || changed.Origin.Locations[0].SourceID != "source-3" || kept.Origin.Layer != LayerBase {
|
if changed.Origin.Layer != LayerOverlay || changed.Origin.Locations[0].SourceID != "source-3" || kept.Origin.Layer != LayerBase {
|
||||||
t.Fatalf("origins = changed %#v kept %#v", changed, kept)
|
t.Fatalf("origins = changed %#v kept %#v", changed, kept)
|
||||||
}
|
}
|
||||||
if _, ok := result.Metadata().Lookup(Keys("value", "child")); ok {
|
if _, ok := result.Metadata().Lookup(Keys("value", "child")); ok {
|
||||||
t.Fatal("removed child remains effective")
|
t.Fatal("removed child remains effective")
|
||||||
}
|
}
|
||||||
childHistory := result.Metadata().History(Keys("value", "child"))
|
childHistory := result.Metadata().History(Keys("value", "child"))
|
||||||
if len(childHistory) < 2 || childHistory[len(childHistory)-1].Path.String() != "/value" || childHistory[len(childHistory)-1].Origin.Layer != LayerProfile {
|
if len(childHistory) < 2 || childHistory[len(childHistory)-1].Path.String() != "/value" || childHistory[len(childHistory)-1].Origin.Layer != LayerOverlay {
|
||||||
t.Fatalf("removed child history = %#v", childHistory)
|
t.Fatalf("removed child history = %#v", childHistory)
|
||||||
}
|
}
|
||||||
if _, ok := result.Metadata().Lookup(Keys("values").Index(1)); ok {
|
if _, ok := result.Metadata().Lookup(Keys("values").Index(1)); ok {
|
||||||
@@ -94,34 +94,43 @@ value: scalar
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadProfileSelectionUsesOneFixedYAMLFile(t *testing.T) {
|
func TestLoadOverlaySelectionUsesOneFixedYAMLFile(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "settings: {kept: base}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "settings: {kept: base}\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "settings: {changed: selected}\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "settings: {changed: selected}\n")
|
||||||
writeImportFile(t, directory, "profiles/default.yml", "settings: {changed: forbidden}\n")
|
writeImportFile(t, directory, "profiles/testing.yml", "settings: {changed: legacy}\n")
|
||||||
|
writeImportFile(t, directory, "overlays/default.yml", "settings: {changed: forbidden}\n")
|
||||||
|
|
||||||
for _, name := range []string{"", "default"} {
|
for _, name := range []string{"", "default"} {
|
||||||
result, err := testLoad[profileTestConfig](File(mainPath), Options[profileTestConfig]{Profile: name})
|
result, err := testLoad[overlayTestConfig](File(mainPath), Options[overlayTestConfig]{Overlay: name})
|
||||||
if err != nil || result.Config.Settings.Changed != "" || len(result.Sources()) != 1 {
|
if err != nil || result.Config.Settings.Changed != "" || len(result.Sources()) != 1 {
|
||||||
t.Fatalf("inactive profile %q = %#v, %v", name, result, err)
|
t.Fatalf("inactive overlay %q = %#v, %v", name, result, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
selected, err := testLoad[profileTestConfig](File(mainPath), Options[profileTestConfig]{Profile: "testing"})
|
selected, err := testLoad[overlayTestConfig](File(mainPath), Options[overlayTestConfig]{Overlay: "testing"})
|
||||||
if err != nil || selected.Config.Settings.Changed != "selected" || len(selected.Sources()) != 2 {
|
if err != nil || selected.Config.Settings.Changed != "selected" || len(selected.Sources()) != 2 ||
|
||||||
t.Fatalf("selected profile = %#v, %v", selected, err)
|
selected.Sources()[1].Label != "overlays/testing.yml" || selected.Sources()[1].Layer != LayerOverlay {
|
||||||
|
t.Fatalf("selected overlay = %#v, %v", selected, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
t.Run("legacy directory is not selected", func(t *testing.T) {
|
||||||
|
legacyDirectory := t.TempDir()
|
||||||
|
legacyMain := writeImportFile(t, legacyDirectory, "main.yml", "settings: {kept: base}\n")
|
||||||
|
writeImportFile(t, legacyDirectory, "profiles/testing.yml", "settings: {changed: legacy}\n")
|
||||||
|
requireOverlayLoadCode(t, File(legacyMain), Options[overlayTestConfig]{Overlay: "testing"}, CodeOverlayMissing)
|
||||||
|
})
|
||||||
|
|
||||||
for _, name := range []string{"../testing", "testing.yml", "one,two", "with space", "é", "bad\x00name"} {
|
for _, name := range []string{"../testing", "testing.yml", "one,two", "with space", "é", "bad\x00name"} {
|
||||||
t.Run(name, func(t *testing.T) {
|
t.Run(name, func(t *testing.T) {
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: name}, CodeOptionsInvalid)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: name}, CodeOptionsInvalid)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "missing"}, CodeProfileMissing)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "missing"}, CodeOverlayMissing)
|
||||||
writeImportFile(t, directory, "profiles/fallback.yaml", "settings: {changed: fallback}\n")
|
writeImportFile(t, directory, "overlays/fallback.yaml", "settings: {changed: fallback}\n")
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "fallback"}, CodeProfileMissing)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "fallback"}, CodeOverlayMissing)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadProfileRejectsDirectivesVersionsAndBaseAliases(t *testing.T) {
|
func TestLoadOverlayRejectsDirectivesVersionsAndBaseAliases(t *testing.T) {
|
||||||
versionRule := &VersionRule{Path: Keys("schema", "version"), Check: func(version Version, _ *Validation) error {
|
versionRule := &VersionRule{Path: Keys("schema", "version"), Check: func(version Version, _ *Validation) error {
|
||||||
if !version.Present || version.Text != "4" {
|
if !version.Present || version.Text != "4" {
|
||||||
return errors.New("unexpected version")
|
return errors.New("unexpected version")
|
||||||
@@ -130,55 +139,55 @@ func TestLoadProfileRejectsDirectivesVersionsAndBaseAliases(t *testing.T) {
|
|||||||
}}
|
}}
|
||||||
for _, test := range []struct {
|
for _, test := range []struct {
|
||||||
name string
|
name string
|
||||||
profile string
|
overlay string
|
||||||
code Code
|
code Code
|
||||||
}{
|
}{
|
||||||
{name: "root directive", profile: "configkit: {}\n", code: CodeProfileDirective},
|
{name: "root directive", overlay: "configkit: {}\n", code: CodeOverlayDirective},
|
||||||
{name: "nested directive", profile: "settings: {configkit: {}}\n", code: CodeProfileDirective},
|
{name: "nested directive", overlay: "settings: {configkit: {}}\n", code: CodeOverlayDirective},
|
||||||
{name: "equal integer version", profile: "schema: {version: 4}\n", code: CodeProfileVersion},
|
{name: "equal integer version", overlay: "schema: {version: 4}\n", code: CodeOverlayVersion},
|
||||||
{name: "ancestor scalar", profile: "schema: null\n", code: CodeProfileVersion},
|
{name: "ancestor scalar", overlay: "schema: null\n", code: CodeOverlayVersion},
|
||||||
} {
|
} {
|
||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "schema: {version: 4}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "schema: {version: 4}\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", test.profile)
|
writeImportFile(t, directory, "overlays/testing.yml", test.overlay)
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "testing", Definition: Definition[profileTestConfig]{Version: versionRule}}, test.code)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "testing", Definition: Definition[overlayTestConfig]{Version: versionRule}}, test.code)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
t.Run("mapping sibling is allowed", func(t *testing.T) {
|
t.Run("mapping sibling is allowed", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "schema: {version: 4}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "schema: {version: 4}\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "schema: {other: allowed}\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "schema: {other: allowed}\n")
|
||||||
result, err := testLoad[profileTestConfig](File(mainPath), Options[profileTestConfig]{Profile: "testing", Definition: Definition[profileTestConfig]{Version: versionRule}})
|
result, err := testLoad[overlayTestConfig](File(mainPath), Options[overlayTestConfig]{Overlay: "testing", Definition: Definition[overlayTestConfig]{Version: versionRule}})
|
||||||
if err != nil || result.Config.Schema["other"] != "allowed" {
|
if err != nil || result.Config.Schema["other"] != "allowed" {
|
||||||
t.Fatalf("mapping sibling = %#v, %v", result, err)
|
t.Fatalf("mapping sibling = %#v, %v", result, err)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("profile aliases imported base", func(t *testing.T) {
|
t.Run("overlay aliases imported base", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "configkit: {imports: [{path: profiles/testing.yml}]}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "configkit: {imports: [{path: overlays/testing.yml}]}\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "settings: {changed: value}\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "settings: {changed: value}\n")
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Imports: true, Profile: "testing"}, CodeProfileRepeated)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Imports: true, Overlay: "testing"}, CodeOverlayRepeated)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadProfileKeepsBaseFailuresAndFilesystemContainment(t *testing.T) {
|
func TestLoadOverlayKeepsBaseFailuresAndFilesystemContainment(t *testing.T) {
|
||||||
t.Run("base parse precedes profile", func(t *testing.T) {
|
t.Run("base parse precedes overlay", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "settings: [\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "settings: [\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "settings: {changed: profile}\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "settings: {changed: overlay}\n")
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "testing"}, CodeYAMLInvalid)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "testing"}, CodeYAMLInvalid)
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("profile parse", func(t *testing.T) {
|
t.Run("overlay parse", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "{}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "{}\n")
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "settings: [\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "settings: [\n")
|
||||||
loadError := requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "testing"}, CodeYAMLInvalid)
|
loadError := requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "testing"}, CodeYAMLInvalid)
|
||||||
if loadError.Diagnostics()[0].Primary.SourceID != "source-2" || len(loadError.Sources()) != 2 {
|
if loadError.Diagnostics()[0].Primary.SourceID != "source-2" || len(loadError.Sources()) != 2 {
|
||||||
t.Fatalf("profile parse attribution = %#v / %#v", loadError.Diagnostics(), loadError.Sources())
|
t.Fatalf("overlay parse attribution = %#v / %#v", loadError.Diagnostics(), loadError.Sources())
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -186,32 +195,32 @@ func TestLoadProfileKeepsBaseFailuresAndFilesystemContainment(t *testing.T) {
|
|||||||
t.Run("symlink escape", func(t *testing.T) {
|
t.Run("symlink escape", func(t *testing.T) {
|
||||||
root := t.TempDir()
|
root := t.TempDir()
|
||||||
outside := t.TempDir()
|
outside := t.TempDir()
|
||||||
outsideProfile := writeImportFile(t, outside, "testing.yml", "settings: {changed: outside}\n")
|
outsideOverlay := writeImportFile(t, outside, "testing.yml", "settings: {changed: outside}\n")
|
||||||
if err := os.Mkdir(filepath.Join(root, "profiles"), 0o755); err != nil {
|
if err := os.Mkdir(filepath.Join(root, "overlays"), 0o755); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if err := os.Symlink(outsideProfile, filepath.Join(root, "profiles/testing.yml")); err != nil {
|
if err := os.Symlink(outsideOverlay, filepath.Join(root, "overlays/testing.yml")); err != nil {
|
||||||
t.Skipf("symlinks unavailable: %v", err)
|
t.Skipf("symlinks unavailable: %v", err)
|
||||||
}
|
}
|
||||||
mainPath := writeImportFile(t, root, "main.yml", "{}\n")
|
mainPath := writeImportFile(t, root, "main.yml", "{}\n")
|
||||||
requireProfileLoadCode(t, File(mainPath), Options[profileTestConfig]{Profile: "testing"}, CodeProfileOutsideRoot)
|
requireOverlayLoadCode(t, File(mainPath), Options[overlayTestConfig]{Overlay: "testing"}, CodeOverlayOutsideRoot)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
t.Run("byte source context", func(t *testing.T) {
|
t.Run("byte source context", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", "settings: {changed: selected}\n")
|
writeImportFile(t, directory, "overlays/testing.yml", "settings: {changed: selected}\n")
|
||||||
result, err := testLoad[profileTestConfig](Bytes("s3://bucket/main.yml", []byte("{}\n")), Options[profileTestConfig]{
|
result, err := testLoad[overlayTestConfig](Bytes("s3://bucket/main.yml", []byte("{}\n")), Options[overlayTestConfig]{
|
||||||
Profile: "testing", Filesystem: &FilesystemContext{BaseDir: directory, Root: directory},
|
Overlay: "testing", Filesystem: &FilesystemContext{BaseDir: directory, Root: directory},
|
||||||
})
|
})
|
||||||
if err != nil || result.Config.Settings.Changed != "selected" {
|
if err != nil || result.Config.Settings.Changed != "selected" {
|
||||||
t.Fatalf("byte profile = %#v, %v", result, err)
|
t.Fatalf("byte overlay = %#v, %v", result, err)
|
||||||
}
|
}
|
||||||
requireProfileLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[profileTestConfig]{Profile: "testing"}, CodeOptionsInvalid)
|
requireOverlayLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[overlayTestConfig]{Overlay: "testing"}, CodeOptionsInvalid)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadProfileCountsAgainstAggregateBudgets(t *testing.T) {
|
func TestLoadOverlayCountsAgainstAggregateBudgets(t *testing.T) {
|
||||||
for _, test := range []struct {
|
for _, test := range []struct {
|
||||||
name string
|
name string
|
||||||
limits func(parsedSource, int) importLimits
|
limits func(parsedSource, int) importLimits
|
||||||
@@ -219,8 +228,8 @@ func TestLoadProfileCountsAgainstAggregateBudgets(t *testing.T) {
|
|||||||
{name: "source count", limits: func(_ parsedSource, _ int) importLimits {
|
{name: "source count", limits: func(_ parsedSource, _ int) importLimits {
|
||||||
return importLimits{sources: 1, bytes: maxTotalBytes, nodes: maxDocumentNodes}
|
return importLimits{sources: 1, bytes: maxTotalBytes, nodes: maxDocumentNodes}
|
||||||
}},
|
}},
|
||||||
{name: "aggregate bytes", limits: func(main parsedSource, profileBytes int) importLimits {
|
{name: "aggregate bytes", limits: func(main parsedSource, overlayBytes int) importLimits {
|
||||||
return importLimits{sources: 2, bytes: main.bytes + int64(profileBytes) - 1, nodes: maxDocumentNodes}
|
return importLimits{sources: 2, bytes: main.bytes + int64(overlayBytes) - 1, nodes: maxDocumentNodes}
|
||||||
}},
|
}},
|
||||||
{name: "aggregate nodes", limits: func(main parsedSource, _ int) importLimits {
|
{name: "aggregate nodes", limits: func(main parsedSource, _ int) importLimits {
|
||||||
return importLimits{sources: 2, bytes: maxTotalBytes, nodes: countInputNodes(main.document) + 1}
|
return importLimits{sources: 2, bytes: maxTotalBytes, nodes: countInputNodes(main.document) + 1}
|
||||||
@@ -229,8 +238,8 @@ func TestLoadProfileCountsAgainstAggregateBudgets(t *testing.T) {
|
|||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "{}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "{}\n")
|
||||||
profileData := "settings: {changed: selected}\n"
|
overlayData := "settings: {changed: selected}\n"
|
||||||
writeImportFile(t, directory, "profiles/testing.yml", profileData)
|
writeImportFile(t, directory, "overlays/testing.yml", overlayData)
|
||||||
main, diagnostics := parseSource(File(mainPath), "source-1", defaultParseLimits())
|
main, diagnostics := parseSource(File(mainPath), "source-1", defaultParseLimits())
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
t.Fatal(diagnostics)
|
t.Fatal(diagnostics)
|
||||||
@@ -241,17 +250,17 @@ func TestLoadProfileCountsAgainstAggregateBudgets(t *testing.T) {
|
|||||||
}
|
}
|
||||||
base.inputBytes = main.bytes
|
base.inputBytes = main.bytes
|
||||||
base.inputNodes = countInputNodes(main.document)
|
base.inputNodes = countInputNodes(main.document)
|
||||||
_, _, diagnostics = loadProfileDocument(File(mainPath), nil, main, base, sourceInfos(main.source), "testing", nil, test.limits(main, len(profileData)))
|
_, _, diagnostics = loadSelectedOverlayDocument(File(mainPath), nil, main, base, sourceInfos(main.source), "testing", nil, test.limits(main, len(overlayData)))
|
||||||
if len(diagnostics) == 0 || diagnostics[0].Code != CodeProfileLimitExceeded {
|
if len(diagnostics) == 0 || diagnostics[0].Code != CodeOverlayLimitExceeded {
|
||||||
t.Fatalf("diagnostics = %#v", diagnostics)
|
t.Fatalf("diagnostics = %#v", diagnostics)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func requireProfileLoadCode(t *testing.T, source Source, options Options[profileTestConfig], code Code) *LoadError {
|
func requireOverlayLoadCode(t *testing.T, source Source, options Options[overlayTestConfig], code Code) *LoadError {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
result, err := testLoad[profileTestConfig](source, options)
|
result, err := testLoad[overlayTestConfig](source, options)
|
||||||
if result != nil || err == nil {
|
if result != nil || err == nil {
|
||||||
t.Fatalf("result, error = %#v, %v", result, err)
|
t.Fatalf("result, error = %#v, %v", result, err)
|
||||||
}
|
}
|
||||||
@@ -23,8 +23,8 @@ func TestNonregularSourcesDoNotBlock(t *testing.T) {
|
|||||||
source = File(filepath.Join(root, "pipe.yml"))
|
source = File(filepath.Join(root, "pipe.yml"))
|
||||||
case "import":
|
case "import":
|
||||||
opts.Imports = true
|
opts.Imports = true
|
||||||
case "profile":
|
case "overlay":
|
||||||
opts.Profile = "fifo"
|
opts.Overlay = "fifo"
|
||||||
}
|
}
|
||||||
_, err := testLoad(source, opts)
|
_, err := testLoad(source, opts)
|
||||||
var loadErr *LoadError
|
var loadErr *LoadError
|
||||||
@@ -38,7 +38,7 @@ func TestNonregularSourcesDoNotBlock(t *testing.T) {
|
|||||||
}
|
}
|
||||||
t.Fatalf("expected nonregular classification, got %v", loadErr.Diagnostics())
|
t.Fatalf("expected nonregular classification, got %v", loadErr.Diagnostics())
|
||||||
}
|
}
|
||||||
for _, mode := range []string{"file", "import", "profile"} {
|
for _, mode := range []string{"file", "import", "overlay"} {
|
||||||
t.Run(mode, func(t *testing.T) {
|
t.Run(mode, func(t *testing.T) {
|
||||||
root := t.TempDir()
|
root := t.TempDir()
|
||||||
input := "value: 1\n"
|
input := "value: 1\n"
|
||||||
@@ -48,12 +48,12 @@ func TestNonregularSourcesDoNotBlock(t *testing.T) {
|
|||||||
if err := os.WriteFile(filepath.Join(root, "config.yml"), []byte(input), 0600); err != nil {
|
if err := os.WriteFile(filepath.Join(root, "config.yml"), []byte(input), 0600); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
if err := os.Mkdir(filepath.Join(root, "profiles"), 0700); err != nil {
|
if err := os.Mkdir(filepath.Join(root, "overlays"), 0700); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
fifo := filepath.Join(root, "pipe.yml")
|
fifo := filepath.Join(root, "pipe.yml")
|
||||||
if mode == "profile" {
|
if mode == "overlay" {
|
||||||
fifo = filepath.Join(root, "profiles", "fifo.yml")
|
fifo = filepath.Join(root, "overlays", "fifo.yml")
|
||||||
}
|
}
|
||||||
if err := syscall.Mkfifo(fifo, 0600); err != nil {
|
if err := syscall.Mkfifo(fifo, 0600); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
|||||||
12
lifecycle.go
12
lifecycle.go
@@ -18,17 +18,17 @@ type Definition[T any] struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Options contains the application definition and per-load input selections.
|
// Options contains the application definition and per-load input selections.
|
||||||
// Imports enables explicit path and glob imports; Profile selects one fixed profile
|
// Imports enables explicit path and glob imports; Overlay selects one fixed overlay;
|
||||||
// overlay; Overrides contains only values explicitly supplied by an application CLI.
|
// Overrides contains only values explicitly supplied by an application CLI.
|
||||||
type Options[T any] struct {
|
type Options[T any] struct {
|
||||||
Definition Definition[T]
|
Definition Definition[T]
|
||||||
Imports bool
|
Imports bool
|
||||||
Profile string
|
Overlay string
|
||||||
Filesystem *FilesystemContext
|
Filesystem *FilesystemContext
|
||||||
Overrides []Override
|
Overrides []Override
|
||||||
}
|
}
|
||||||
|
|
||||||
// FilesystemContext supplies filesystem roots for imports and profiles.
|
// FilesystemContext supplies filesystem roots for imports and overlays.
|
||||||
type FilesystemContext struct {
|
type FilesystemContext struct {
|
||||||
BaseDir string
|
BaseDir string
|
||||||
Root string
|
Root string
|
||||||
@@ -75,7 +75,7 @@ type Result[T any] struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
||||||
// imports, and one selected profile. It accepts at most one Options value and
|
// imports, and one selected overlay. It accepts at most one Options value and
|
||||||
// returns no result when any error is reported.
|
// returns no result when any error is reported.
|
||||||
func Load[T any](source Source, supplied ...Options[T]) (*Result[T], error) {
|
func Load[T any](source Source, supplied ...Options[T]) (*Result[T], error) {
|
||||||
options := make([]engine.Options[T], len(supplied))
|
options := make([]engine.Options[T], len(supplied))
|
||||||
@@ -219,7 +219,7 @@ func toEngineOptions[T any](options Options[T]) engine.Options[T] {
|
|||||||
result := engine.Options[T]{
|
result := engine.Options[T]{
|
||||||
Definition: toEngineDefinition(options.Definition),
|
Definition: toEngineDefinition(options.Definition),
|
||||||
Imports: options.Imports,
|
Imports: options.Imports,
|
||||||
Profile: options.Profile,
|
Overlay: options.Overlay,
|
||||||
}
|
}
|
||||||
if options.Filesystem != nil {
|
if options.Filesystem != nil {
|
||||||
result.Filesystem = &engine.FilesystemContext{BaseDir: options.Filesystem.BaseDir, Root: options.Filesystem.Root}
|
result.Filesystem = &engine.FilesystemContext{BaseDir: options.Filesystem.BaseDir, Root: options.Filesystem.Root}
|
||||||
|
|||||||
16
records.go
16
records.go
@@ -6,7 +6,7 @@ type Layer string
|
|||||||
const (
|
const (
|
||||||
LayerDefault Layer = "default"
|
LayerDefault Layer = "default"
|
||||||
LayerBase Layer = "base"
|
LayerBase Layer = "base"
|
||||||
LayerProfile Layer = "profile"
|
LayerOverlay Layer = "overlay"
|
||||||
LayerCLI Layer = "cli"
|
LayerCLI Layer = "cli"
|
||||||
LayerResolution Layer = "resolution"
|
LayerResolution Layer = "resolution"
|
||||||
)
|
)
|
||||||
@@ -90,13 +90,13 @@ const (
|
|||||||
CodeImportLimitExceeded Code = "import.limit_exceeded"
|
CodeImportLimitExceeded Code = "import.limit_exceeded"
|
||||||
CodeImportVersion Code = "import.version"
|
CodeImportVersion Code = "import.version"
|
||||||
|
|
||||||
CodeProfileInvalid Code = "profile.invalid"
|
CodeOverlayInvalid Code = "overlay.invalid"
|
||||||
CodeProfileMissing Code = "profile.missing"
|
CodeOverlayMissing Code = "overlay.missing"
|
||||||
CodeProfileOutsideRoot Code = "profile.outside_root"
|
CodeOverlayOutsideRoot Code = "overlay.outside_root"
|
||||||
CodeProfileRepeated Code = "profile.repeated"
|
CodeOverlayRepeated Code = "overlay.repeated"
|
||||||
CodeProfileDirective Code = "profile.directive"
|
CodeOverlayDirective Code = "overlay.directive"
|
||||||
CodeProfileVersion Code = "profile.version"
|
CodeOverlayVersion Code = "overlay.version"
|
||||||
CodeProfileLimitExceeded Code = "profile.limit_exceeded"
|
CodeOverlayLimitExceeded Code = "overlay.limit_exceeded"
|
||||||
|
|
||||||
CodeComposeInvalid Code = "compose.invalid"
|
CodeComposeInvalid Code = "compose.invalid"
|
||||||
CodeComposeConflict Code = "compose.conflict"
|
CodeComposeConflict Code = "compose.conflict"
|
||||||
|
|||||||
22
records_test.go
Normal file
22
records_test.go
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
package configkit
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestOverlayPublicValues(t *testing.T) {
|
||||||
|
if LayerOverlay != "overlay" {
|
||||||
|
t.Fatalf("LayerOverlay = %q", LayerOverlay)
|
||||||
|
}
|
||||||
|
for code, value := range map[Code]string{
|
||||||
|
CodeOverlayInvalid: "overlay.invalid",
|
||||||
|
CodeOverlayMissing: "overlay.missing",
|
||||||
|
CodeOverlayOutsideRoot: "overlay.outside_root",
|
||||||
|
CodeOverlayRepeated: "overlay.repeated",
|
||||||
|
CodeOverlayDirective: "overlay.directive",
|
||||||
|
CodeOverlayVersion: "overlay.version",
|
||||||
|
CodeOverlayLimitExceeded: "overlay.limit_exceeded",
|
||||||
|
} {
|
||||||
|
if string(code) != value {
|
||||||
|
t.Errorf("code = %q, want %q", code, value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,8 +9,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
func TestDevelopmentCheckHandlesFilenamesAndStopsOnFailure(t *testing.T) {
|
||||||
for _, scriptName := range []string{"release-check.sh", "check.sh"} {
|
for _, scriptName := range []string{"check.sh"} {
|
||||||
t.Run(scriptName, func(t *testing.T) {
|
t.Run(scriptName, func(t *testing.T) {
|
||||||
script, err := os.ReadFile("scripts/" + scriptName)
|
script, err := os.ReadFile("scripts/" + scriptName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -66,7 +66,7 @@ func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
cmd := exec.Command("/bin/bash", filepath.Join(root, "scripts", scriptName))
|
cmd := exec.Command("/bin/bash", filepath.Join(root, "scripts", scriptName))
|
||||||
cmd.Env = append(os.Environ(), "PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"), "CONFIGKIT_BASELINE_TOOLCHAIN=test-baseline", "CONFIGKIT_NEWER_TOOLCHAIN=test-newer", "CONFIGKIT_TEST_FMT_LOG="+log, "CONFIGKIT_TEST_GO_LOG="+calls)
|
cmd.Env = append(os.Environ(), "PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"), "CONFIGKIT_BASELINE_TOOLCHAIN=test-baseline", "CONFIGKIT_NEWER_TOOLCHAIN=", "CONFIGKIT_TEST_FMT_LOG="+log, "CONFIGKIT_TEST_GO_LOG="+calls)
|
||||||
// Log only targets selected by the script, not inherited host settings.
|
// Log only targets selected by the script, not inherited host settings.
|
||||||
cmd.Env = append(cmd.Env, "GOOS=", "GOARCH=")
|
cmd.Env = append(cmd.Env, "GOOS=", "GOARCH=")
|
||||||
if name == "failed-go-check" {
|
if name == "failed-go-check" {
|
||||||
@@ -103,19 +103,95 @@ func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
|||||||
if fail && strings.Contains(string(invoked), "vet ./...") {
|
if fail && strings.Contains(string(invoked), "vet ./...") {
|
||||||
t.Fatal("checker continued after failed test")
|
t.Fatal("checker continued after failed test")
|
||||||
}
|
}
|
||||||
if scriptName == "release-check.sh" && !fail {
|
|
||||||
// These are selected release gates, not incidental loop details.
|
|
||||||
for _, target := range []string{"linux/amd64", "linux/arm64"} {
|
|
||||||
if !strings.Contains(string(invoked), target+" build ./...") {
|
|
||||||
t.Errorf("checker omitted required target %s", target)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if strings.Contains(string(invoked), "darwin/") {
|
|
||||||
t.Fatal("checker requires best-effort macOS validation")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCheckScriptsReleaseGates(t *testing.T) {
|
||||||
|
script, err := os.ReadFile("scripts/release-check.sh")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, scenario := range []string{"success", "failed-test", "missing-toolchain"} {
|
||||||
|
t.Run(scenario, func(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
bin := t.TempDir()
|
||||||
|
for _, directory := range []string{"scripts", "nested"} {
|
||||||
|
if err := os.Mkdir(filepath.Join(root, directory), 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
checker := filepath.Join(root, "scripts", "release-check.sh")
|
||||||
|
if err := os.WriteFile(checker, script, 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
calls := filepath.Join(bin, "go.calls")
|
||||||
|
goStub := `#!/bin/sh
|
||||||
|
printf '%s|%s|%s|%s|%s|%s\n' "$GOTOOLCHAIN" "$GOPROXY" "${CGO_ENABLED-}" "${GOOS-}" "${GOARCH-}" "$*" >> "$CONFIGKIT_TEST_GO_LOG"
|
||||||
|
if [ "${CONFIGKIT_TEST_FAIL-}" = toolchain ] && [ "${1-}" = version ]; then exit 37; fi
|
||||||
|
if [ "${CONFIGKIT_TEST_FAIL-}" = test ] && [ "${1-}" = test ]; then exit 37; fi
|
||||||
|
`
|
||||||
|
if err := os.WriteFile(filepath.Join(bin, "go"), []byte(goStub), 0700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cmd := exec.Command("/bin/bash", checker)
|
||||||
|
cmd.Dir = filepath.Join(root, "nested")
|
||||||
|
cmd.Env = append(os.Environ(),
|
||||||
|
"PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"),
|
||||||
|
"CONFIGKIT_BASELINE_TOOLCHAIN=test-baseline",
|
||||||
|
"CONFIGKIT_TEST_GO_LOG="+calls,
|
||||||
|
"GOOS=", "GOARCH=", "CGO_ENABLED=",
|
||||||
|
)
|
||||||
|
switch scenario {
|
||||||
|
case "failed-test":
|
||||||
|
cmd.Env = append(cmd.Env, "CONFIGKIT_TEST_FAIL=test")
|
||||||
|
case "missing-toolchain":
|
||||||
|
cmd.Env = append(cmd.Env, "CONFIGKIT_TEST_FAIL=toolchain")
|
||||||
|
}
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if scenario == "success" && err != nil {
|
||||||
|
t.Fatalf("checker: %v\n%s", err, output)
|
||||||
|
}
|
||||||
|
if scenario != "success" && err == nil {
|
||||||
|
t.Fatalf("checker accepted %s", scenario)
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(calls)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
lines := strings.Split(strings.TrimSpace(string(data)), "\n")
|
||||||
|
for _, line := range lines {
|
||||||
|
if !strings.HasPrefix(line, "test-baseline|off|") {
|
||||||
|
t.Fatalf("toolchain or offline setting lost: %q", line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scenario == "missing-toolchain" {
|
||||||
|
if len(lines) != 1 || !strings.HasSuffix(lines[0], "|version") {
|
||||||
|
t.Fatalf("checker ran after unavailable toolchain: %q", lines)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(lines) < 2 || lines[1] != "test-baseline|off||||test -mod=readonly -vet=off -race -v ./..." {
|
||||||
|
t.Fatalf("release suite command changed: %q", lines)
|
||||||
|
}
|
||||||
|
if scenario == "failed-test" {
|
||||||
|
if len(lines) != 2 {
|
||||||
|
t.Fatalf("checker continued after failure: %q", lines)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
want := []string{
|
||||||
|
"test-baseline|off||||version",
|
||||||
|
"test-baseline|off||||test -mod=readonly -vet=off -race -v ./...",
|
||||||
|
"test-baseline|off||||vet -mod=readonly ./...",
|
||||||
|
"test-baseline|off|0|linux|amd64|build -mod=readonly ./...",
|
||||||
|
"test-baseline|off|0|linux|arm64|build -mod=readonly ./...",
|
||||||
|
}
|
||||||
|
if strings.Join(lines, "\n") != strings.Join(want, "\n") {
|
||||||
|
t.Fatalf("unexpected release gates:\n%s", data)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
359
release_publish_test.go
Normal file
359
release_publish_test.go
Normal file
@@ -0,0 +1,359 @@
|
|||||||
|
package configkit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type releaseFixture struct {
|
||||||
|
t *testing.T
|
||||||
|
root string
|
||||||
|
remote string
|
||||||
|
base string
|
||||||
|
candidate string
|
||||||
|
validationLog string
|
||||||
|
realGit string
|
||||||
|
}
|
||||||
|
|
||||||
|
func newReleaseFixture(t *testing.T) *releaseFixture {
|
||||||
|
t.Helper()
|
||||||
|
realGit, err := exec.LookPath("git")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
f := &releaseFixture{
|
||||||
|
t: t,
|
||||||
|
root: t.TempDir(),
|
||||||
|
remote: filepath.Join(t.TempDir(), "remote.git"),
|
||||||
|
validationLog: filepath.Join(t.TempDir(), "validator.log"),
|
||||||
|
realGit: realGit,
|
||||||
|
}
|
||||||
|
f.git("init", "-q", "-b", "main")
|
||||||
|
f.git("init", "-q", "--bare", f.remote)
|
||||||
|
f.git("config", "user.name", "Test")
|
||||||
|
f.git("config", "user.email", "test@example.invalid")
|
||||||
|
f.git("config", "commit.gpgsign", "false")
|
||||||
|
f.git("config", "tag.gpgsign", "false")
|
||||||
|
f.git("config", "push.followTags", "true")
|
||||||
|
f.git("remote", "add", "origin", f.remote)
|
||||||
|
f.write(".gitignore", "ignored.log\n", 0600)
|
||||||
|
f.write("README.md", "fixture\n", 0600)
|
||||||
|
f.git("add", ".")
|
||||||
|
f.git("commit", "-qm", "Initial source")
|
||||||
|
f.base = f.git("rev-parse", "HEAD")
|
||||||
|
f.git("push", f.remote, "HEAD:refs/heads/main")
|
||||||
|
|
||||||
|
script, err := os.ReadFile("scripts/release.sh")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// Only the fixture copy substitutes the authoritative endpoint.
|
||||||
|
local := strings.ReplaceAll(string(script), "https://gitea.maximumdirect.net/eric/ConfigKit.git", f.remote)
|
||||||
|
f.write("scripts/release.sh", local, 0700)
|
||||||
|
f.write("scripts/release-check.sh", `#!/bin/sh
|
||||||
|
printf 'validate\n' >> "$CONFIGKIT_VALIDATION_LOG"
|
||||||
|
case "${CONFIGKIT_VALIDATOR_ACTION-}" in
|
||||||
|
fail) exit 37 ;;
|
||||||
|
change) git commit --allow-empty -qm 'Changed during validation' ;;
|
||||||
|
dirty) printf 'changed\n' > unexpected.txt ;;
|
||||||
|
remote-tag) git --git-dir="$CONFIGKIT_REMOTE" update-ref refs/tags/v0.9.0 "$CONFIGKIT_BASE" ;;
|
||||||
|
esac
|
||||||
|
`, 0700)
|
||||||
|
f.write("docs/releases/v0.9.0.md", "# ConfigKit v0.9.0\n\nConfiguration loading fixes.\n\nCompatibility is unchanged.\n", 0600)
|
||||||
|
f.git("add", ".")
|
||||||
|
f.git("commit", "-qm", "Prepared source")
|
||||||
|
f.candidate = f.git("rev-parse", "HEAD")
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) write(path, contents string, mode os.FileMode) {
|
||||||
|
f.t.Helper()
|
||||||
|
target := filepath.Join(f.root, path)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(target), 0700); err != nil {
|
||||||
|
f.t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(target, []byte(contents), mode); err != nil {
|
||||||
|
f.t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) git(args ...string) string {
|
||||||
|
f.t.Helper()
|
||||||
|
cmd := exec.Command(f.realGit, args...)
|
||||||
|
cmd.Dir = f.root
|
||||||
|
cmd.Env = append(os.Environ(), "GIT_ALLOW_PROTOCOL=file", "GIT_CONFIG_NOSYSTEM=1", "GIT_CONFIG_GLOBAL=/dev/null")
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
f.t.Fatalf("git %v: %v\n%s", args, err, out)
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(string(out))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) gitResult(args ...string) (string, error) {
|
||||||
|
f.t.Helper()
|
||||||
|
cmd := exec.Command(f.realGit, args...)
|
||||||
|
cmd.Dir = f.root
|
||||||
|
cmd.Env = append(os.Environ(), "GIT_ALLOW_PROTOCOL=file", "GIT_CONFIG_NOSYSTEM=1", "GIT_CONFIG_GLOBAL=/dev/null")
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
return strings.TrimSpace(string(out)), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) run(version, behavior, validatorAction string) (string, error) {
|
||||||
|
f.t.Helper()
|
||||||
|
bin := f.t.TempDir()
|
||||||
|
wrapper := `#!/bin/sh
|
||||||
|
if [ "${CONFIGKIT_GIT_BEHAVIOR-}" = main-unknown ] || [ "${CONFIGKIT_GIT_BEHAVIOR-}" = tag-unknown ]; then
|
||||||
|
if [ "${1-}" = ls-remote ] && [ -f "$CONFIGKIT_GIT_MARKER" ]; then exit 37; fi
|
||||||
|
fi
|
||||||
|
case "$*" in
|
||||||
|
push\ *|-c\ remote.origin.mirror=false\ push\ *)
|
||||||
|
case "$*" in
|
||||||
|
*refs/heads/main*)
|
||||||
|
case "${CONFIGKIT_GIT_BEHAVIOR-}" in
|
||||||
|
main-lost) "$CONFIGKIT_REAL_GIT" "$@" >/dev/null 2>&1; exit 37 ;;
|
||||||
|
main-reject) exit 37 ;;
|
||||||
|
main-unknown) : > "$CONFIGKIT_GIT_MARKER"; exit 37 ;;
|
||||||
|
esac ;;
|
||||||
|
*refs/tags/v0.9.0*)
|
||||||
|
case "${CONFIGKIT_GIT_BEHAVIOR-}" in
|
||||||
|
tag-lost) "$CONFIGKIT_REAL_GIT" "$@" >/dev/null 2>&1; exit 37 ;;
|
||||||
|
tag-reject) exit 37 ;;
|
||||||
|
tag-conflict)
|
||||||
|
"$CONFIGKIT_REAL_GIT" --git-dir="$CONFIGKIT_REMOTE" update-ref refs/tags/v0.9.0 "$CONFIGKIT_BASE"
|
||||||
|
exit 37 ;;
|
||||||
|
tag-unknown) : > "$CONFIGKIT_GIT_MARKER"; exit 37 ;;
|
||||||
|
esac ;;
|
||||||
|
esac
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
exec "$CONFIGKIT_REAL_GIT" "$@"
|
||||||
|
`
|
||||||
|
if err := os.WriteFile(filepath.Join(bin, "git"), []byte(wrapper), 0700); err != nil {
|
||||||
|
f.t.Fatal(err)
|
||||||
|
}
|
||||||
|
nested := filepath.Join(f.root, "nested")
|
||||||
|
if err := os.Mkdir(nested, 0700); err != nil {
|
||||||
|
f.t.Fatal(err)
|
||||||
|
}
|
||||||
|
cmd := exec.Command("/bin/bash", filepath.Join(f.root, "scripts", "release.sh"), version)
|
||||||
|
cmd.Dir = nested
|
||||||
|
cmd.Env = append(os.Environ(),
|
||||||
|
"PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"),
|
||||||
|
"GIT_ALLOW_PROTOCOL=file", "GIT_CONFIG_NOSYSTEM=1", "GIT_CONFIG_GLOBAL=/dev/null",
|
||||||
|
"CONFIGKIT_VALIDATION_LOG="+f.validationLog,
|
||||||
|
"CONFIGKIT_VALIDATOR_ACTION="+validatorAction,
|
||||||
|
"CONFIGKIT_GIT_BEHAVIOR="+behavior,
|
||||||
|
"CONFIGKIT_GIT_MARKER="+filepath.Join(bin, "push-seen"),
|
||||||
|
"CONFIGKIT_REAL_GIT="+f.realGit,
|
||||||
|
"CONFIGKIT_REMOTE="+f.remote,
|
||||||
|
"CONFIGKIT_BASE="+f.base,
|
||||||
|
)
|
||||||
|
out, err := cmd.CombinedOutput()
|
||||||
|
return string(out), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) validations() int {
|
||||||
|
f.t.Helper()
|
||||||
|
data, err := os.ReadFile(f.validationLog)
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
f.t.Fatal(err)
|
||||||
|
}
|
||||||
|
return strings.Count(string(data), "validate\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *releaseFixture) remoteRef(ref string) string {
|
||||||
|
f.t.Helper()
|
||||||
|
value, err := f.gitResult("--git-dir="+f.remote, "rev-parse", "--verify", ref)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReleasePublicationGuards(t *testing.T) {
|
||||||
|
for _, scenario := range []string{
|
||||||
|
"success", "main-already-current", "ignored-file", "unrelated-tag",
|
||||||
|
"malformed-version", "wrong-branch", "wrong-destination", "multiple-destinations",
|
||||||
|
"dirty-worktree", "changed-candidate", "missing-note", "mismatched-note",
|
||||||
|
"local-tag", "remote-tag", "remote-tag-after-validation",
|
||||||
|
"dirty-after-validation", "remote-query-failure",
|
||||||
|
"failed-validation", "non-fast-forward",
|
||||||
|
} {
|
||||||
|
t.Run(scenario, func(t *testing.T) {
|
||||||
|
f := newReleaseFixture(t)
|
||||||
|
version := "v0.9.0"
|
||||||
|
validatorAction := ""
|
||||||
|
switch scenario {
|
||||||
|
case "main-already-current":
|
||||||
|
f.git("push", f.remote, "HEAD:refs/heads/main")
|
||||||
|
case "ignored-file":
|
||||||
|
f.write("ignored.log", "local only\n", 0600)
|
||||||
|
case "unrelated-tag":
|
||||||
|
f.git("tag", "-a", "-m", "Unrelated", "v0.8.0", f.base)
|
||||||
|
case "malformed-version":
|
||||||
|
version = "v00.9.0"
|
||||||
|
case "wrong-branch":
|
||||||
|
f.git("checkout", "-qb", "feature")
|
||||||
|
case "wrong-destination":
|
||||||
|
other := filepath.Join(t.TempDir(), "other.git")
|
||||||
|
f.git("init", "-q", "--bare", other)
|
||||||
|
f.git("remote", "set-url", "--push", "origin", other)
|
||||||
|
case "multiple-destinations":
|
||||||
|
f.git("remote", "set-url", "--push", "origin", f.remote)
|
||||||
|
f.git("remote", "set-url", "--add", "--push", "origin", filepath.Join(t.TempDir(), "other.git"))
|
||||||
|
case "dirty-worktree":
|
||||||
|
f.write("untracked.txt", "unexpected\n", 0600)
|
||||||
|
case "changed-candidate":
|
||||||
|
validatorAction = "change"
|
||||||
|
case "dirty-after-validation":
|
||||||
|
validatorAction = "dirty"
|
||||||
|
case "missing-note":
|
||||||
|
f.git("rm", "docs/releases/v0.9.0.md")
|
||||||
|
f.git("commit", "-qm", "Remove note")
|
||||||
|
case "mismatched-note":
|
||||||
|
f.write("docs/releases/v0.9.0.md", "# ConfigKit v0.9.1\n", 0600)
|
||||||
|
f.git("add", ".")
|
||||||
|
f.git("commit", "-qm", "Mismatch note")
|
||||||
|
case "local-tag":
|
||||||
|
f.git("tag", "v0.9.0")
|
||||||
|
case "remote-tag":
|
||||||
|
f.git("tag", "v0.9.0")
|
||||||
|
f.git("push", f.remote, "refs/tags/v0.9.0")
|
||||||
|
f.git("tag", "-d", "v0.9.0")
|
||||||
|
case "remote-tag-after-validation":
|
||||||
|
validatorAction = "remote-tag"
|
||||||
|
case "remote-query-failure":
|
||||||
|
if err := os.Rename(f.remote, f.remote+".unavailable"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
case "failed-validation":
|
||||||
|
validatorAction = "fail"
|
||||||
|
case "non-fast-forward":
|
||||||
|
f.git("checkout", "-qb", "other", f.base)
|
||||||
|
f.git("commit", "--allow-empty", "-qm", "Divergent source")
|
||||||
|
f.git("push", f.remote, "HEAD:refs/heads/main")
|
||||||
|
f.git("checkout", "main")
|
||||||
|
}
|
||||||
|
out, err := f.run(version, "", validatorAction)
|
||||||
|
success := scenario == "success" || scenario == "main-already-current" ||
|
||||||
|
scenario == "ignored-file" || scenario == "unrelated-tag"
|
||||||
|
if success != (err == nil) {
|
||||||
|
t.Fatalf("unexpected publication result: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
wantChecks := 1
|
||||||
|
switch scenario {
|
||||||
|
case "malformed-version", "wrong-branch", "wrong-destination",
|
||||||
|
"multiple-destinations", "dirty-worktree", "missing-note",
|
||||||
|
"mismatched-note", "local-tag", "remote-tag", "remote-query-failure",
|
||||||
|
"non-fast-forward":
|
||||||
|
wantChecks = 0
|
||||||
|
}
|
||||||
|
if got := f.validations(); got != wantChecks {
|
||||||
|
t.Fatalf("validator ran %d times, want %d", got, wantChecks)
|
||||||
|
}
|
||||||
|
if success {
|
||||||
|
if got := f.remoteRef("refs/heads/main"); got != f.candidate {
|
||||||
|
t.Fatalf("published main %s, want %s", got, f.candidate)
|
||||||
|
}
|
||||||
|
if got := f.remoteRef("refs/tags/v0.9.0^{}"); got != f.candidate {
|
||||||
|
t.Fatalf("tag points to %s, want %s", got, f.candidate)
|
||||||
|
}
|
||||||
|
if f.remoteRef("refs/tags/v0.8.0") != "" {
|
||||||
|
t.Fatal("unrelated local tag was published")
|
||||||
|
}
|
||||||
|
tagData := f.git("--git-dir="+f.remote, "cat-file", "-p", "refs/tags/v0.9.0")
|
||||||
|
_, message, ok := strings.Cut(tagData, "\n\n")
|
||||||
|
if !ok || strings.TrimSpace(message) != strings.TrimSpace(f.git("show", f.candidate+":docs/releases/v0.9.0.md")) {
|
||||||
|
t.Fatal("annotated tag does not contain the checked-in note")
|
||||||
|
}
|
||||||
|
} else if scenario != "remote-tag" && scenario != "remote-tag-after-validation" &&
|
||||||
|
f.remoteRef("refs/tags/v0.9.0") != "" {
|
||||||
|
t.Fatal("failed guard published a tag")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReleasePublicationRecovery(t *testing.T) {
|
||||||
|
for _, scenario := range []string{
|
||||||
|
"main-lost", "main-reject", "main-unknown",
|
||||||
|
"tag-lost", "tag-reject", "tag-conflict", "tag-unknown",
|
||||||
|
} {
|
||||||
|
t.Run(scenario, func(t *testing.T) {
|
||||||
|
f := newReleaseFixture(t)
|
||||||
|
out, err := f.run("v0.9.0", scenario, "")
|
||||||
|
success := scenario == "main-lost" || scenario == "tag-lost"
|
||||||
|
if success != (err == nil) {
|
||||||
|
t.Fatalf("unexpected publication result: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if got := f.validations(); got != 1 {
|
||||||
|
t.Fatalf("validator ran %d times", got)
|
||||||
|
}
|
||||||
|
remoteMain := f.remoteRef("refs/heads/main")
|
||||||
|
remoteTag := f.remoteRef("refs/tags/v0.9.0")
|
||||||
|
localTag, localTagErr := f.gitResult("rev-parse", "--verify", "refs/tags/v0.9.0")
|
||||||
|
if localTagErr != nil {
|
||||||
|
localTag = ""
|
||||||
|
}
|
||||||
|
switch scenario {
|
||||||
|
case "main-lost", "tag-lost":
|
||||||
|
if remoteMain != f.candidate || remoteTag == "" || remoteTag != localTag {
|
||||||
|
t.Fatal("confirmed publication did not preserve exact refs")
|
||||||
|
}
|
||||||
|
case "main-reject", "main-unknown":
|
||||||
|
if remoteMain != f.base || remoteTag != "" || localTag != "" {
|
||||||
|
t.Fatal("failed main push created publication state")
|
||||||
|
}
|
||||||
|
case "tag-reject", "tag-unknown":
|
||||||
|
if remoteMain != f.candidate || remoteTag != "" || localTag == "" {
|
||||||
|
t.Fatal("failed tag push did not retain branch-only state")
|
||||||
|
}
|
||||||
|
case "tag-conflict":
|
||||||
|
if remoteMain != f.candidate || remoteTag != f.base || localTag == "" {
|
||||||
|
t.Fatal("conflicting remote tag was overwritten")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReleasePublicationUsesValidatedDestination(t *testing.T) {
|
||||||
|
for _, behavior := range []string{"success", "main-lost", "tag-lost"} {
|
||||||
|
t.Run(behavior, func(t *testing.T) {
|
||||||
|
f := newReleaseFixture(t)
|
||||||
|
other := filepath.Join(t.TempDir(), "other.git")
|
||||||
|
f.git("init", "-q", "--bare", other)
|
||||||
|
f.git("remote", "set-url", "--push", "origin", f.remote)
|
||||||
|
f.git("config", "url."+other+".pushInsteadOf", f.remote)
|
||||||
|
// These defaults must not broaden the explicit release refspecs when
|
||||||
|
// publishing through the validated named remote.
|
||||||
|
f.git("config", "remote.origin.mirror", "true")
|
||||||
|
f.git("config", "remote.origin.push", "refs/heads/*:refs/heads/*")
|
||||||
|
f.git("branch", "unrelated", f.base)
|
||||||
|
f.git("tag", "-a", "-m", "Unrelated", "v0.8.0", f.base)
|
||||||
|
f.git("--git-dir="+f.remote, "update-ref", "refs/heads/keep", f.base)
|
||||||
|
|
||||||
|
out, err := f.run("v0.9.0", behavior, "")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("publish: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if f.validations() != 1 || f.remoteRef("refs/heads/main") != f.candidate ||
|
||||||
|
f.remoteRef("refs/tags/v0.9.0") != f.git("rev-parse", "refs/tags/v0.9.0") {
|
||||||
|
t.Fatal("publication did not reach the validated destination")
|
||||||
|
}
|
||||||
|
if f.remoteRef("refs/heads/keep") != f.base ||
|
||||||
|
f.remoteRef("refs/heads/unrelated") != "" || f.remoteRef("refs/tags/v0.8.0") != "" {
|
||||||
|
t.Fatal("publication changed unrelated refs")
|
||||||
|
}
|
||||||
|
if refs := f.git("--git-dir="+other, "for-each-ref", "--format=%(refname)"); refs != "" {
|
||||||
|
t.Fatalf("publication reached the rewrite destination: %s", refs)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,7 +5,6 @@ repository_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)
|
|||||||
cd "$repository_dir"
|
cd "$repository_dir"
|
||||||
|
|
||||||
baseline_toolchain=${CONFIGKIT_BASELINE_TOOLCHAIN:?set CONFIGKIT_BASELINE_TOOLCHAIN to a cached supported Go 1.25 patch release}
|
baseline_toolchain=${CONFIGKIT_BASELINE_TOOLCHAIN:?set CONFIGKIT_BASELINE_TOOLCHAIN to a cached supported Go 1.25 patch release}
|
||||||
newer_toolchain=${CONFIGKIT_NEWER_TOOLCHAIN:?set CONFIGKIT_NEWER_TOOLCHAIN to a cached newer supported Go toolchain}
|
|
||||||
|
|
||||||
run_go() {
|
run_go() {
|
||||||
local toolchain=$1
|
local toolchain=$1
|
||||||
@@ -13,77 +12,18 @@ run_go() {
|
|||||||
GOTOOLCHAIN="$toolchain" GOPROXY=off go "$@"
|
GOTOOLCHAIN="$toolchain" GOPROXY=off go "$@"
|
||||||
}
|
}
|
||||||
|
|
||||||
check_toolchain() {
|
if ! GOTOOLCHAIN="$baseline_toolchain" GOPROXY=off go version >/dev/null; then
|
||||||
local toolchain=$1
|
printf 'release toolchain %s is unavailable; acquire it before validation\n' "$baseline_toolchain" >&2
|
||||||
GOTOOLCHAIN="$toolchain" GOPROXY=off go version >/dev/null
|
|
||||||
run_go "$toolchain" mod download
|
|
||||||
}
|
|
||||||
|
|
||||||
check_toolchain "$baseline_toolchain"
|
|
||||||
check_toolchain "$newer_toolchain"
|
|
||||||
bash -n scripts/release-check.sh
|
|
||||||
|
|
||||||
temporary_dir=$(mktemp -d)
|
|
||||||
trap 'rm -rf -- "$temporary_dir"' EXIT
|
|
||||||
candidate_manifest=$temporary_dir/candidate-files
|
|
||||||
while IFS= read -r -d '' candidate_file; do
|
|
||||||
if [[ -e "$candidate_file" || -L "$candidate_file" ]]; then
|
|
||||||
printf '%s\0' "$candidate_file" >>"$candidate_manifest"
|
|
||||||
fi
|
|
||||||
done < <(git ls-files --cached --others --exclude-standard -z)
|
|
||||||
tar --null --files-from="$candidate_manifest" --create --file=- |
|
|
||||||
tar --extract --file=- --directory="$temporary_dir"
|
|
||||||
(
|
|
||||||
cd "$temporary_dir"
|
|
||||||
GOTOOLCHAIN="$baseline_toolchain" GOPROXY=off go mod tidy
|
|
||||||
)
|
|
||||||
diff -u go.mod "$temporary_dir/go.mod"
|
|
||||||
diff -u go.sum "$temporary_dir/go.sum"
|
|
||||||
|
|
||||||
go_files=()
|
|
||||||
while IFS= read -r -d '' go_file; do
|
|
||||||
if [[ -f "$go_file" ]]; then
|
|
||||||
go_files+=("$go_file")
|
|
||||||
fi
|
|
||||||
done < <(git ls-files --cached --others --exclude-standard -z -- '*.go')
|
|
||||||
if ((${#go_files[@]})); then
|
|
||||||
unformatted=$(gofmt -l -- "${go_files[@]}")
|
|
||||||
if [[ -n "$unformatted" ]]; then
|
|
||||||
printf 'gofmt required for:\n%s\n' "$unformatted" >&2
|
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
fi
|
|
||||||
|
|
||||||
git diff --check HEAD --
|
# Verbose output reports skipped cases without a separate evidence run.
|
||||||
while IFS= read -r -d '' candidate_file; do
|
run_go "$baseline_toolchain" test -mod=readonly -vet=off -race -v ./...
|
||||||
if [[ ! -f "$candidate_file" ]]; then
|
run_go "$baseline_toolchain" vet -mod=readonly ./...
|
||||||
continue
|
|
||||||
fi
|
|
||||||
case "$candidate_file" in
|
|
||||||
*.go|*.md|*.sh|go.mod|go.sum|LICENSE|.gitignore|AGENTS.md)
|
|
||||||
if LC_ALL=C grep -nE '[[:blank:]]+$' -- "$candidate_file"; then
|
|
||||||
printf 'trailing whitespace found in %s\n' "$candidate_file" >&2
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done < <(git ls-files --cached --others --exclude-standard -z)
|
|
||||||
|
|
||||||
for toolchain in "$baseline_toolchain" "$newer_toolchain"; do
|
|
||||||
run_go "$toolchain" test ./...
|
|
||||||
run_go "$toolchain" vet ./...
|
|
||||||
run_go "$toolchain" build ./...
|
|
||||||
done
|
|
||||||
|
|
||||||
run_go "$newer_toolchain" test -race ./...
|
|
||||||
run_go "$newer_toolchain" test . -run '^Example'
|
|
||||||
run_go "$newer_toolchain" test ./examples/consumers
|
|
||||||
run_go "$newer_toolchain" test . -run '^TestLocalDocumentationLinks$'
|
|
||||||
run_go "$newer_toolchain" test . -run '^TestDependencyImportBoundary$'
|
|
||||||
|
|
||||||
# Only release-validated targets gate publication; macOS is best-effort.
|
# Only release-validated targets gate publication; macOS is best-effort.
|
||||||
for target in linux/amd64 linux/arm64; do
|
for target in linux/amd64 linux/arm64; do
|
||||||
target_os=${target%/*}
|
target_os=${target%/*}
|
||||||
target_arch=${target#*/}
|
target_arch=${target#*/}
|
||||||
GOTOOLCHAIN="$newer_toolchain" GOPROXY=off CGO_ENABLED=0 GOOS="$target_os" GOARCH="$target_arch" go build ./...
|
GOTOOLCHAIN="$baseline_toolchain" GOPROXY=off CGO_ENABLED=0 GOOS="$target_os" GOARCH="$target_arch" go build -mod=readonly ./...
|
||||||
done
|
done
|
||||||
|
|||||||
133
scripts/release.sh
Executable file
133
scripts/release.sh
Executable file
@@ -0,0 +1,133 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
repository_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." && pwd)
|
||||||
|
cd "$repository_dir"
|
||||||
|
|
||||||
|
remote_url=https://gitea.maximumdirect.net/eric/ConfigKit.git
|
||||||
|
|
||||||
|
fail() {
|
||||||
|
printf '%s\n' "$*" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
check_candidate() {
|
||||||
|
local context=$1 current status
|
||||||
|
current=$(git branch --show-current) || fail "$context: cannot read the current branch"
|
||||||
|
[[ "$current" == main ]] || fail "$context: release requires the main branch"
|
||||||
|
status=$(git status --porcelain=v1 --untracked-files=all) || fail "$context: cannot inspect the worktree"
|
||||||
|
[[ -z "$status" ]] || fail "$context: release requires a clean index and worktree"
|
||||||
|
current=$(git rev-parse --verify HEAD) || fail "$context: cannot identify the candidate"
|
||||||
|
[[ "$current" == "$candidate" ]] || fail "$context: candidate changed; commit and validate it again"
|
||||||
|
}
|
||||||
|
|
||||||
|
check_unused_version() {
|
||||||
|
if git show-ref --verify --quiet "refs/tags/$version"; then
|
||||||
|
fail "version already has a local tag"
|
||||||
|
fi
|
||||||
|
local oid result
|
||||||
|
if oid=$(read_remote_ref "refs/tags/$version"); then
|
||||||
|
fail "version already has an authoritative tag"
|
||||||
|
else
|
||||||
|
result=$?
|
||||||
|
((result == 2)) || fail "cannot determine authoritative tag state; publication status is unknown"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
read_remote_ref() {
|
||||||
|
local ref=$1 response result
|
||||||
|
if response=$(git ls-remote --refs --exit-code origin "$ref" 2>/dev/null); then
|
||||||
|
[[ "$response" == *$'\t'"$ref" ]] || return 3
|
||||||
|
printf '%s\n' "${response%%$'\t'*}"
|
||||||
|
else
|
||||||
|
result=$?
|
||||||
|
((result == 2)) && return 2
|
||||||
|
return 3
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
if (($# != 1)); then
|
||||||
|
fail "usage: ./scripts/release.sh vMAJOR.MINOR.PATCH"
|
||||||
|
fi
|
||||||
|
version=$1
|
||||||
|
[[ "$version" =~ ^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$ ]] ||
|
||||||
|
fail "release version must be a stable vMAJOR.MINOR.PATCH without leading zeroes"
|
||||||
|
|
||||||
|
fetch_urls=$(git remote get-url --all origin 2>/dev/null) || fail "origin is unavailable"
|
||||||
|
push_urls=$(git remote get-url --push --all origin 2>/dev/null) || fail "origin push destination is unavailable"
|
||||||
|
[[ "$fetch_urls" == "$remote_url" && "$push_urls" == "$remote_url" ]] ||
|
||||||
|
fail "origin must have exactly the authoritative fetch and push destination"
|
||||||
|
|
||||||
|
candidate=$(git rev-parse --verify HEAD) || fail "cannot identify the candidate"
|
||||||
|
check_candidate "before validation"
|
||||||
|
check_unused_version
|
||||||
|
|
||||||
|
note_path="docs/releases/$version.md"
|
||||||
|
note_file=$(mktemp)
|
||||||
|
trap 'rm -f -- "$note_file"' EXIT
|
||||||
|
git show "$candidate:$note_path" >"$note_file" 2>/dev/null ||
|
||||||
|
fail "matching release note is absent from the candidate"
|
||||||
|
IFS= read -r title <"$note_file" || [[ -n "$title" ]] ||
|
||||||
|
fail "matching release note is empty"
|
||||||
|
[[ "$title" == "# ConfigKit $version" ]] || fail "release note title does not match the version"
|
||||||
|
|
||||||
|
if remote_main=$(read_remote_ref refs/heads/main); then
|
||||||
|
:
|
||||||
|
else
|
||||||
|
result=$?
|
||||||
|
((result == 2)) && fail "authoritative main is absent"
|
||||||
|
fail "cannot read authoritative main; publication status is unknown"
|
||||||
|
fi
|
||||||
|
git fetch --no-tags origin refs/heads/main >/dev/null ||
|
||||||
|
fail "cannot fetch authoritative main"
|
||||||
|
fetched_main=$(git rev-parse --verify FETCH_HEAD) || fail "cannot inspect fetched main"
|
||||||
|
git merge-base --is-ancestor "$fetched_main" "$candidate" ||
|
||||||
|
fail "candidate cannot advance authoritative main without discarding history"
|
||||||
|
|
||||||
|
./scripts/release-check.sh || fail "release validation failed; no refs were published"
|
||||||
|
check_candidate "after validation"
|
||||||
|
check_unused_version
|
||||||
|
|
||||||
|
# Use the named remote whose resolved destinations were checked above: a literal
|
||||||
|
# URL can apply pushInsteadOf even when origin's explicit push URL does not.
|
||||||
|
# Disable mirror defaults as well as implicit tags; publish only our refspec.
|
||||||
|
if git -c remote.origin.mirror=false push --no-follow-tags origin "$candidate:refs/heads/main"; then
|
||||||
|
:
|
||||||
|
else
|
||||||
|
if observed_main=$(read_remote_ref refs/heads/main); then
|
||||||
|
[[ "$observed_main" == "$candidate" ]] ||
|
||||||
|
fail "main push did not publish candidate $candidate; authoritative main differs"
|
||||||
|
else
|
||||||
|
result=$?
|
||||||
|
((result == 2)) && fail "main push failed for $candidate; authoritative main is absent"
|
||||||
|
fail "main push outcome is unknown for $candidate; inspect authoritative main before retrying"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
check_candidate "main at $candidate; tag not yet published"
|
||||||
|
git tag -a -F "$note_file" --cleanup=verbatim "$version" "$candidate" ||
|
||||||
|
fail "main is at $candidate; could not create local tag $version"
|
||||||
|
tag_target=$(git rev-parse --verify "refs/tags/$version^{}") ||
|
||||||
|
fail "main is at $candidate; cannot verify local tag $version"
|
||||||
|
[[ "$tag_target" == "$candidate" ]] || fail "main is at $candidate; local tag $version targets another commit"
|
||||||
|
tag_type=$(git cat-file -t "refs/tags/$version") ||
|
||||||
|
fail "main is at $candidate; cannot inspect local tag $version"
|
||||||
|
[[ "$tag_type" == tag ]] || fail "main is at $candidate; local tag $version is not annotated"
|
||||||
|
tag_oid=$(git rev-parse --verify "refs/tags/$version") ||
|
||||||
|
fail "main is at $candidate; cannot identify local tag $version"
|
||||||
|
|
||||||
|
if git -c remote.origin.mirror=false push --no-follow-tags origin "refs/tags/$version:refs/tags/$version"; then
|
||||||
|
:
|
||||||
|
else
|
||||||
|
if observed_tag=$(read_remote_ref "refs/tags/$version"); then
|
||||||
|
[[ "$observed_tag" == "$tag_oid" ]] ||
|
||||||
|
fail "authoritative tag $version conflicts with the local tag at $candidate; never replace it"
|
||||||
|
else
|
||||||
|
result=$?
|
||||||
|
((result == 2)) &&
|
||||||
|
fail "tag push failed; main is at $candidate, but local tag $version is unpublished"
|
||||||
|
fail "tag $version push outcome is unknown for $candidate; retain the local tag and inspect authoritative state"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
printf 'Published %s at %s\n' "$version" "$candidate"
|
||||||
Reference in New Issue
Block a user