Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate package metadata, improve packaging documentation, refactor record package schema #1640

Merged
merged 25 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
01c1a88
release-package-schema: Remove validation keywords and deprecate fields
duncandewhurst Oct 3, 2023
cfe4d5c
record-package-schema: Remove validation keywords and deprecate fields
duncandewhurst Oct 8, 2023
c40d7bf
docs/schema/reference.md: Don't collapse publisher in package metadata
duncandewhurst Oct 8, 2023
989a05e
Merge branch '1.2-dev' into 1621-deprecate-package-metadata
duncandewhurst Oct 11, 2023
cbc010d
.gitignore: Add python-version (used by pyenv)
duncandewhurst Oct 11, 2023
63227a6
docs/examples: Remove deprecated package fields
duncandewhurst Oct 11, 2023
910ec05
docs/schema: Restructure package reference
duncandewhurst Oct 11, 2023
acb2aa0
record-package-schema: Refactor to create separate record schema
duncandewhurst Oct 13, 2023
4ec9396
docs/schema/packaging: Fix schema browsers
duncandewhurst Oct 13, 2023
b760544
docs/schema/packaging: Fix schema browsers
duncandewhurst Oct 13, 2023
316cd79
Apply suggestions from code review
duncandewhurst Nov 2, 2023
80d245b
schema/record-schema.json: Make LinkedRelease.url non-nullable
duncandewhurst Nov 2, 2023
710ab21
docs/history/changelog.md: Remove references to reverted PR
duncandewhurst Nov 2, 2023
3d1b39d
schema/release-package-schema.json: Update deprecation descriptions
duncandewhurst Nov 3, 2023
d4e6897
Update changelog
duncandewhurst Nov 3, 2023
5b3358e
docs/schema/packaging/release_package.md: Copy-edit
duncandewhurst Nov 3, 2023
caf95de
ci: Run lint on both push and pull_request events (only pull_request …
jpmckinney Nov 3, 2023
df4e7d9
ci: Run lint on only pushes to protected branches or tags
jpmckinney Nov 3, 2023
ddfdc0c
docs/schema/records_reference.md: Add record structure example
duncandewhurst Nov 6, 2023
b486573
guidance/publish: Cut content about "license" field
jpmckinney Nov 6, 2023
0bc8f3c
guidance/publish: Reword non-normative license content for readability
jpmckinney Nov 6, 2023
fd9d975
guidance/serialization: Remove content about deprecated package-level…
jpmckinney Nov 6, 2023
d02cfda
changelog: Add entry about LinkedRelease.url types
jpmckinney Nov 7, 2023
bc4b252
schema/records_reference: Move content before note
jpmckinney Nov 7, 2023
2963d21
Update docs/schema/packaging/release_package.md
duncandewhurst Nov 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ env:
BASEDIR: https://raw.githubusercontent.com/open-contracting/standard-maintenance-scripts/main
jobs:
build:
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
if: github.event_name == 'pull_request' || startsWith(github.event.ref, 'refs/tags/') || startsWith(github.event.ref, 'refs/heads/1.1') || startsWith(github.event.ref, 'refs/heads/1.2')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
/docs/_static/patched
/src
*.pyc
.python-version
6 changes: 0 additions & 6 deletions docs/examples/amendments/contract.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-d2phr6-12b0ab8ac4c28d322a82062e99918856",
"publisher": {
"name": "Department of Finance"
},
"publishedDate": "2019-02-17T00:00:00Z",
"license": "https://creativecommons.org/licenses/by/3.0/au/",
"version": "1.1",
"records": [
{
Expand Down
6 changes: 0 additions & 6 deletions docs/examples/amendments/easy_releases.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-d2phr6-1000035663",
"publisher": {
"name": "Department of Finance"
},
"publishedDate": "",
"license": "https://creativecommons.org/licenses/by/3.0/au/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/amendments/tender.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00002.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2016-02-05T10:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
5 changes: 0 additions & 5 deletions docs/examples/beneficial_ownership/award.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
{
"uri": "https://www.contractsfinder.service.gov.uk/Published/Notice/releases/87d46d06-3abf-4f48-9f1d-ff3381fcb29a.json",
"publishedDate": "2021-06-08T14:14:33Z",
"publisher": {
"name": "UK SHARED BUSINESS SERVICES LIMITED"
},
"version": "1.1",
"releases": [
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
{
"uri": "https://public.mtender.gov.md/ocds/tenders/ocds-b3wdp1-MD-1602178295495",
"publishedDate": "2020-10-08T17:31:35Z",
"publisher": {
"name": "M-Tender"
},
"version": "1.1",
"extensions": [
"https://raw.githubusercontent.com/open-contracting-extensions/ocds_beneficialOwners_extension/master/extension.json"
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/award.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-04-award.json",
"publishedDate": "2010-05-10T09:30:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/contract.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-05-contract.json",
"publishedDate": "2010-06-10T10:30:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/contractAmendment.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-07-contractAmendment.json",
"publishedDate": "2011-04-05T13:30:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/implementation.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-06-implementation.json",
"publishedDate": "2011-01-10T09:30:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/award.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2010-05-10T09:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/contract.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2010-06-10T10:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/contractAmendment.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2011-04-05T13:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/implementation.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2011-01-10T09:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/tender.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2010-03-15T09:30:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/records/tenderUpdate.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2010-03-20T09:45:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"records": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/tender.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-02-tender.json",
"publishedDate": "2010-03-01T09:30:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/tenderAmendment.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderAmendment.json",
"publishedDate": "2010-03-20T10:45:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.1",
"extensions": [],
"releases": [
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/change_history/tenderUpdate.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/releases/ocds-213czf-000-00001-03-tenderUpdate.json",
"publishedDate": "2010-03-20T09:45:00Z",
"publisher": {
"scheme": "GB-COH",
"uid": "09506232",
"name": "Open Data Services Co-operative Limited",
"uri": "https://standard.open-contracting.org/examples/"
},
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"version": "1.2",
"extensions": [],
"releases": [
Expand Down
5 changes: 0 additions & 5 deletions docs/examples/contract_suspension/suspended_contract.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
{
"uri": "https://standard.open-contracting.org/examples/release/ocds-afalqw-601848b51321e56ae2593b1b",
"publisher": {
"name": "National Procurement Authority, Afghanistan"
},
"publishedDate": "2021-02-01T23:00:13+04:30",
"version": "1.1",
"releases": [
{
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example1/award.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2019-12-27T14:42:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2019-12-27T14:42:00Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example1/contract.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2020-01-11T07:53:50Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2020-01-11T07:53:50Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example1/tender.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2019-12-01T09:00:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2019-12-01T09:00:00Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example1/tender_update.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2019-12-04T09:00:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2019-12-03T09:00:00Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example2/award.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2019-12-27T14:42:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2019-12-27T14:42:00Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example2/contract.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2020-01-11T07:53:50Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2020-01-11T07:53:50Z",
Expand Down
10 changes: 0 additions & 10 deletions docs/examples/easy_releases/worked_example2/tender.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"uri": "https://standard.open-contracting.org/examples/",
"version": "1.1",
"publisher": {
"uid": "80048717-6",
"name": "Direccion Nacional de Contrataciones Públicas",
"scheme": "PY-RUC",
"uri": "https://standard.open-contracting.org/examples/"
},
"publishedDate": "2019-12-01T09:00:00Z",
"license": "http://opendatacommons.org/licenses/pddl/1.0/",
"publicationPolicy": "https://github.com/open-contracting/sample-data/",
"releases": [
{
"date": "2019-12-01T09:00:00Z",
Expand Down
Loading