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

Merge main into v7.1 #470

Merged
merged 9 commits into from
May 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# For documentation on the format of this file, see
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2

Check warning on line 4 in .github/dependabot.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

4:1 [document-start] missing document start "---"
updates:

- package-ecosystem: "github-actions"
# Workflow files stored in the
# default location of `.github/workflows`
directory: "/"
schedule:
interval: "weekly"
day: "saturday"
80 changes: 40 additions & 40 deletions .github/workflows/generate-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
#
# For documentation on the syntax of this file, see
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Build

Check warning on line 8 in .github/workflows/generate-files.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

8:1 [document-start] missing document start "---"

on:

Check warning on line 10 in .github/workflows/generate-files.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

10:1 [truthy] truthy value should be one of [false, true]
push:
branches: [ main, v7.1 ]
branches: [main, v7.1]

permissions:
contents: read
Expand All @@ -25,48 +25,48 @@
EXTDIR: ../extracted-files/

steps:
- name: Check out GEDCOM
uses: actions/checkout@v4
- name: Check out GEDCOM
uses: actions/checkout@v4

- name: Get the branch name
id: extract_branch
run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
- name: Get the branch name
id: extract_branch
run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"

- name: Install mdformat-gfm
run: pip install mdformat-gfm
- name: Install mdformat-gfm
run: pip install mdformat-gfm

- name: Generate files
working-directory: ${{github.workspace}}/build
shell: sh
run: |
export MD_FILES=$(ls ${{ env.SPECDIR }}gedcom*.md | sort)
python3 extract-grammars.py ${MD_FILES} ${{ env.EXTDIR }}
python3 uri-def.py ${MD_FILES} ${{ env.EXTDIR }}tags
ls -l ${{env.EXTDIR}}
- name: Generate files
working-directory: ${{github.workspace}}/build
shell: sh
run: |
export MD_FILES=$(ls ${{ env.SPECDIR }}gedcom*.md | sort)
python3 extract-grammars.py ${MD_FILES} ${{ env.EXTDIR }}
python3 uri-def.py ${MD_FILES} ${{ env.EXTDIR }}tags
ls -l ${{env.EXTDIR}}

- name: Set git config
env:
GH_TOKEN: ${{ github.token }}
run: |
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
git config --global user.name "$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
git config -l
- name: Set git config
env:
GH_TOKEN: ${{ github.token }}
run: |
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
git config --global user.name "$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
git config -l

- name: Check for diffs
id: diff
run: |
git diff --quiet origin/${{steps.extract_branch.outputs.branch}} extracted-files || echo "::set-output name=status::changes"
shell: bash
- name: Check for diffs
id: diff
run: |
git diff --quiet origin/${{steps.extract_branch.outputs.branch}} extracted-files || echo "::set-output name=status::changes"
shell: bash

- name: Create Pull Request
if: steps.diff.outputs.status == 'changes'
run: |
git checkout -b ${{steps.extract_branch.outputs.branch}}-generate-files
git add extracted-files
git commit -m "Update extracted files"
git push -f origin ${{steps.extract_branch.outputs.branch}}-generate-files
if ! gh pr list | grep -q "${{steps.extract_branch.outputs.branch}}-generate-files"; then
gh pr create -B ${{steps.extract_branch.outputs.branch}} -H ${{steps.extract_branch.outputs.branch}}-generate-files --title 'Update extracted-files in ${{steps.extract_branch.outputs.branch}}' --body $'Update extracted files\nThis PR is auto-generated by [gh pr create].' --label 'automated pr'
fi
env:
GH_TOKEN: ${{ github.token }}
- name: Create Pull Request
if: steps.diff.outputs.status == 'changes'
run: |
git checkout -b ${{steps.extract_branch.outputs.branch}}-generate-files
git add extracted-files
git commit -m "Update extracted files"
git push -f origin ${{steps.extract_branch.outputs.branch}}-generate-files
if ! gh pr list | grep -q "${{steps.extract_branch.outputs.branch}}-generate-files"; then
gh pr create -B ${{steps.extract_branch.outputs.branch}} -H ${{steps.extract_branch.outputs.branch}}-generate-files --title 'Update extracted-files in ${{steps.extract_branch.outputs.branch}}' --body $'Update extracted files\nThis PR is auto-generated by [gh pr create].' --label 'automated pr'
fi
env:
GH_TOKEN: ${{ github.token }}
52 changes: 26 additions & 26 deletions .github/workflows/propagate-main-to-v7.1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,47 +5,47 @@
#
# For documentation on the syntax of this file, see
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Build

Check warning on line 8 in .github/workflows/propagate-main-to-v7.1.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

8:1 [document-start] missing document start "---"

on:

Check warning on line 10 in .github/workflows/propagate-main-to-v7.1.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

10:1 [truthy] truthy value should be one of [false, true]
push:
branches: [ main ]
branches: [main]

permissions:
contents: read

jobs:
merge-to-v7.1:
merge-to-v71:
permissions:
contents: write # for Git to git push
pull-requests: write # for Git to create a pull request
runs-on: ubuntu-latest

steps:
- name: Check out GEDCOM
uses: actions/checkout@v4
- name: Check out GEDCOM
uses: actions/checkout@v4

- name: Set git config
env:
GH_TOKEN: ${{ github.token }}
run: |
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
git config --global user.name "$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
git config -l
- name: Set git config
env:
GH_TOKEN: ${{ github.token }}
run: |
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
git config --global user.name "$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
git config -l

- name: Check for diffs
id: diff
run: |
git fetch origin
git diff --quiet origin/main..origin/v7.1 || echo "::set-output name=status::changes"
- name: Check for diffs
id: diff
run: |
git fetch origin
git diff --quiet origin/main..origin/v7.1 || echo "::set-output name=status::changes"

- name: Create Pull Request
if: steps.diff.outputs.status == 'changes'
run: |
git checkout -b merge-main-into-v7.1
git push -f --set-upstream origin merge-main-into-v7.1
if ! gh pr list | grep -q "merge-main-into-v7.1"; then
gh pr create -B v7.1 -H merge-main-into-v7.1 --title 'Merge main into v7.1' --body $'Copy changes from main to v7.1\nThis PR is auto-generated by [gh pr create].' --label 'automated pr' --repo ${{ github.repository }}
fi
env:
GH_TOKEN: ${{ github.token }}
- name: Create Pull Request
if: steps.diff.outputs.status == 'changes'
run: |
git checkout -b merge-main-into-v7.1
git push -f --set-upstream origin merge-main-into-v7.1
if ! gh pr list | grep -q "merge-main-into-v7.1"; then
gh pr create -B v7.1 -H merge-main-into-v7.1 --title 'Merge main into v7.1' --body $'Copy changes from main to v7.1\nThis PR is auto-generated by [gh pr create].' --label 'automated pr' --repo ${{ github.repository }}
fi
env:
GH_TOKEN: ${{ github.token }}
26 changes: 26 additions & 0 deletions .github/workflows/validate-yaml.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# For documentation on the github environment, see
# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners
#
# For documentation on the syntax of this file, see
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Validate-YAML

Check warning on line 6 in .github/workflows/validate-yaml.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

6:1 [document-start] missing document start "---"

on:

Check warning on line 8 in .github/workflows/validate-yaml.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

8:1 [truthy] truthy value should be one of [false, true]
push:
branches: [main, v7.1, next-patch]
pull_request:
branches: [main, v7.1, next-patch]

permissions:
contents: read

jobs:
validate-yaml:
runs-on: ubuntu-latest

steps:
- name: Checkout GEDCOM
uses: actions/checkout@v4

- name: Validate YAML
run: yamllint .
7 changes: 7 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Configuration file for yamllint. For documentation, see
# https://yamllint.readthedocs.io/en/stable/configuration.html

extends: default

Check warning on line 4 in .yamllint.yml

View workflow job for this annotation

GitHub Actions / validate-yaml

4:1 [document-start] missing document start "---"

rules:
line-length: disable
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,15 @@ If you are looking for FamilySearch's GEDCOM 5.5.1 Java parser, which previously
- `main` contains the current release.
Patch versions are generally pushed directly to `main` upon approval.

- `next-minor` contains a working draft of the next minor release. Changes from `main` have been discussed and approved by the working group supervising the next minor release, but have not been fully vetted and approved for inclusion in the standard and may change at any time without notice.
- `v7.1` contains a working draft of the next minor release. Changes from `main` have been discussed and approved by the working group supervising the next minor release, meaning they are (a) minor, not major, changes, as described in [A Guide to Version Numbers](https://gedcom.io/specifications/FamilySearchGEDCOMv7.html#a-guide-to-version-numbers) and (b) have been judged as meeting all three of the following criteria for inclusion:

- All other branches are for conversation drafts that may or may not be incorporated into a future version of the specification.
- **Valuable**: they are present in historical records and are either defining aspects of a person's life or otherwise important for informing research or creating life summaries
- **Absent**: they are meaningfully distinct from, and not merely a more detailed subtype of, existing structure types
- **Used**: multiple family history applications with active user bases either use it now or have expressed a desire to add it as soon as it is available in the standard

Until v7.1 is released, this branch may be changed at any time without notice.

- `sandbox` contains candidate text for various possible changes that might or might not be included in future releases, often because they have not yet been demonstrated to meet the "used" criteria.

- All other branches are for conversation drafts, potentially to be incorporated into one of the above branches or to be deleted.

31 changes: 31 additions & 0 deletions attribute-event-requests/FAM-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Guides for using this document can be found in the associated [README.md](README
| | | [Lived Together](#lived-together) | perhaps `RESI`? |
| `NCHI` | 5.0 | Number of children | |
| `RESI` | 3.0 | Residence | |
| | | [Separated](#separated) | |

# Details

Expand Down Expand Up @@ -53,3 +54,33 @@ Related proposals include
### Used

- Used by the [FamilySearch API](https://www.familysearch.org/developers/docs/guides/facts) with URI `http://familysearch.org/v1/LivedTogether`

## Separated

### Description

*proposed description missing*

*In [GEDCOM X](https://github.com/FamilySearch/gedcomx/blob/master/specifications/fact-types-specification.md) as* "A fact of a couple's separation."

### Value

Found in the following historical records:

- (records not yet identified)

### Absence

There is no other structure that covers this event, as it can apply to couples that cohabitate
and are not married as well as to those who are married in some manner. And for those who are
married, some couples may separate and never actually file for or go through with a formal divorce.

### Used

- Part of the [GEDCOM X specification](https://github.com/FamilySearch/gedcomx/blob/master/specifications/fact-types-specification.md) with URI `http://gedcomx.org/Separation`

- The CompGen [CompGen](https://www.compgen.de/) table of [custom GEDCOM tags](https://wiki.genealogy.net/GEDCOM/_Nutzerdef-Tag) shows:

1. `_SEPR` used by Brother's Keeper for Windows 6, WebTrees, and Family Tree Maker for both DOS and Windows

2. `SEPA` used by Reunion for MAC and Legacy
29 changes: 29 additions & 0 deletions attribute-event-requests/FAM-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Guides for using this document can be found in the associated [README.md](README
| `MARB` | 4.0 | Marriage Bann | |
| `MARL` | 4.0 | Marriage License | |
| `MARS` | 4.0 | Marriage Settlement | |
| | | [Separation](#separation) | |

# Details

Expand Down Expand Up @@ -85,3 +86,31 @@ In [GEDCOM X](https://github.com/FamilySearch/gedcomx/blob/master/specifications
## Marriage

In [GEDCOM X](https://github.com/FamilySearch/gedcomx/blob/master/specifications/fact-types-specification.md) with URI `http://gedcomx.org/Marriage`

## Separation

### Description

*proposed description missing*

*In [GEDCOM X](https://github.com/FamilySearch/gedcomx/blob/master/specifications/fact-types-specification.md) as* "A fact of a couple's separation."

### Value

Found in the following historical records:

- (records not yet identified)

### Absence

There is no other structure that covers this event, as it can apply to couples that cohabitate and are not married as well as to those who are married in some manner. And for those who are married, some couples may separate and never actually file for or go through with a formal divorce.

### Used

- Part of the [GEDCOM X specification](https://github.com/FamilySearch/gedcomx/blob/master/specifications/fact-types-specification.md) with URI `http://gedcomx.org/Separation`

- The CompGen [CompGen](https://www.compgen.de/) table of [custom GEDCOM tags](https://wiki.genealogy.net/GEDCOM/_Nutzerdef-Tag) shows:

1. `_SEPR` used by Brother's Keeper for Windows 6, WebTrees, and Family Tree Maker for both DOS and Windows

2. `SEPA` used by Reunion for MAC and Legacy
1 change: 1 addition & 0 deletions build/uri-def.py
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ def expand_prefix(txt, prefixes):
is_used_by = True
print(' - "'+expand_prefix(tag2,prefixes)+'"', file=fh)

print('\ncontact: "https://gedcom.io/community/"', file=fh)
fh.write('...\n')

print('done')
Expand Down
2 changes: 2 additions & 0 deletions extracted-files/tags/ABBR
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@ substructures: {}

superstructures:
"https://gedcom.io/terms/v7/record-SOUR": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADDR
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,6 @@ superstructures:
"https://gedcom.io/terms/v7/WILL": "{0:1}"
"https://gedcom.io/terms/v7/record-REPO": "{0:1}"
"https://gedcom.io/terms/v7/record-SUBM": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADOP
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,6 @@ superstructures:
value of:
- "https://gedcom.io/terms/v7/enumset-EVEN"
- "https://gedcom.io/terms/v7/enumset-EVENATTR"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADOP-FAMC
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ substructures:

superstructures:
"https://gedcom.io/terms/v7/ADOP": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADR1
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,6 @@ substructures: {}

superstructures:
"https://gedcom.io/terms/v7/ADDR": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADR2
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,6 @@ substructures: {}

superstructures:
"https://gedcom.io/terms/v7/ADDR": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ADR3
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,6 @@ substructures: {}

superstructures:
"https://gedcom.io/terms/v7/ADDR": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/AGE
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,6 @@ superstructures:
"https://gedcom.io/terms/v7/SSN": "{0:1}"
"https://gedcom.io/terms/v7/WIFE": "{1:1}"
"https://gedcom.io/terms/v7/WILL": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/AGNC
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,6 @@ superstructures:
"https://gedcom.io/terms/v7/RETI": "{0:1}"
"https://gedcom.io/terms/v7/SSN": "{0:1}"
"https://gedcom.io/terms/v7/WILL": "{0:1}"

contact: "https://gedcom.io/community/"
...
2 changes: 2 additions & 0 deletions extracted-files/tags/ALIA
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,6 @@ substructures:

superstructures:
"https://gedcom.io/terms/v7/record-INDI": "{0:M}"

contact: "https://gedcom.io/community/"
...
Loading
Loading