Staging of v1.1.0 #365

ml-evs · 2021-06-11T16:58:04Z

From discussion in #366 and at the workshop, it looks like the most reasonable option is to release v1.1.0 and skip v1.0.1. This PR stages those changes.

This is also adds GitHub actions The rest for now are still on Travis and can be moved at a later stage; in any case they require a different environment (java vs. python)

because they were intended to have trailing spaces to check the syntax :-) Excluding these two files explicitly now from the pre-commit

Marking 'develop' for the future work.

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

…-space Adding pre-commit tests (for trailing whitespaces)

…in-URL Remove a space in an example URL

* Updated schemas to the latest generated by optimade-python-tools v0.12.0 Co-authored-by: Casper Welzel Andersen <casper.andersen@epfl.ch>

* Added Java tests to GH actions * Renamed GH actions file

* Added swagger validation using curl/jq and validator.swagger.io * Restructured CI into multiple jobs * Bump pre-commit version as suggested previously * Disabled Travis

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Add field for implementation issue tracker

Fix incorrect example in assemblies

* Added Zenodo citation * Update README.md * Use HTTPS and link to unversioned DOI

) * Sorted allowed word list for cleaner diff * Added new audit tooling for spellchecking * Fixed spelling mistakes in specification and updated .words.lst with 'make fix_spellings'

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Redefine species.mass as a list of floats

…330) * Updated schema to optimade-python-tools v0.12.9

* Update OpenAPI schemas for v0.13.0 of python-tools * Bumped OPTIMADE spec version (1.0.1) and optimade-python-tools version (0.13.1) * Use version number 1.0.1~develop * Added regexp for prefix from v0.13.2 of python-tools * Use 1.0.0~develop as the version tag

The related OPTIMADE Python tools PR: Materials-Consortia/optimade-python-tools#731. The changes are related to enumerations (Python Enum sub-classes), extending information about them and defining the default value for the aggregate field attribute for a links resource.

… element names (#371) * replaced name with symbol when refering to the abreviation of the element names. * Update optimade.rst Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com> Co-authored-by: Johan Bergsma <johan.bergsma@gmx.com> Co-authored-by: Matthew Evans <7916000+ml-evs@users.noreply.github.com>

* Add v1.1.0 schemas from optimade-python-tools v0.16.0 * Incorporate changes from #367

ml-evs · 2021-07-07T18:45:27Z

I have just bumped the version number in this PR (i.e. develop) to 1.1.0, so this is now ready for a final review and release.

@rartino: in the wiki release instructions, it talks about doing a -ff-only merge locally. I think this is equivalent to a GitHub PR rebase+merge, which I think is preferable...

optimade.rst

rartino · 2021-07-07T21:37:55Z

@rartino: in the wiki release instructions, it talks about doing a -ff-only merge locally. I think this is equivalent to a GitHub PR rebase+merge, which I think is preferable...

I think the instructions were devised by @CasperWA originally, and were created before GitHub had these merge options. However, reading the documentation, I'm actually not sure that 'Rebase and merge' would be equivalent, because the documentation says the commit hashes will be updated, which we would like to avoid.

rartino

The v1.1.0 release looks ready to me.

ml-evs · 2021-07-07T22:58:01Z

I think the instructions were devised by @CasperWA originally, and were created before GitHub had these merge options. However, reading the documentation, I'm actually not sure that 'Rebase and merge' would be equivalent, because the documentation says the commit hashes will be updated, which we would like to avoid.

I'm 90% sure that GitHub will do a ff-only rebase when the history is linear (as it is here) but I will triple check in another repo. The GitHub docs do allude to this too. Let's see what @CasperWA says.

merkys

Looks good!

rartino · 2021-07-08T06:47:20Z

I'm 90% sure that GitHub will do a ff-only rebase when the history is linear (as it is here) but I will triple check in another repo.

They indeed say that the merge is done fast-forward:

When you select the Rebase and merge option on a pull request on GitHub, all commits from the topic branch (or head branch) are added onto the base branch individually without a merge commit. Pull requests with rebased commits are merged using the fast-forward option. [...]

However, this other paragraph just below makes it sound as if that fast-forward is done using re-written (rebased) commits with different hashes:

The rebase and merge behavior on GitHub deviates slightly from git rebase. Rebase and merge on GitHub will always update the committer information and create new commit SHAs, whereas git rebase outside of GitHub does not change the committer information when the rebase happens on top of an ancestor commit.

ml-evs · 2021-07-08T10:43:55Z

Final steps:

I've written a little script to check all external links in the specification, we might consider adding this (or something similar) to the CI.
The release will need release notes: I think it makes sense to also add these to a top-level CHANGELOG.md in this repository (I believe this was discussed at one point, but not actioned upon). I will copy the notes from 1.0.0 and write new ones for 1.1 in a new PR, so we will need one more round of reviews for this.
Once this PR is approved again, I will locally merge the branch.

JPBergsma

I did not see any major issues in this draft PR.
And great, that you made a script to test external links.

* Added a CHANGELOG containing release notes * Add link to CHANGELOG in README * Formatting * Add clarifying word * Apply suggestions from code review Co-authored-by: Rickard Armiento <gitcommits@armiento.net> * Placate pre-commit Co-authored-by: Rickard Armiento <gitcommits@armiento.net>

ml-evs · 2021-07-08T15:17:15Z

Proceeding with the local merge... wish me luck!

ml-evs · 2021-07-08T15:21:27Z

🎉

giovannipizzi and others added 30 commits July 1, 2020 17:50

Adding pre-commit tests (for traling whitespaces)

97ba7ef

This is also adds GitHub actions The rest for now are still on Travis and can be moved at a later stage; in any case they require a different environment (java vs. python)

Reverting changes on two test inputs

0c3a9dc

because they were intended to have trailing spaces to check the syntax :-) Excluding these two files explicitly now from the pre-commit

Marking 'develop' for the future work.

c1ee8ec

Merge pull request #311 from Materials-Consortia/develop_further_1.0

5588b55

Marking 'develop' for the future work.

Update .pre-commit-config.yaml

5a49911

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Merge pull request #306 from Materials-Consortia/add-precommit-checks…

c91ceca

…-space Adding pre-commit tests (for trailing whitespaces)

Fixing a typo: 'severing' -> 'serving' (#313)

3c308e3

Added missing species subfields to type list (#316)

fd8247f

Removing space in an URL.

b64c3db

Merge pull request #325 from Materials-Consortia/merkys/remove-space-…

7ba92e0

…in-URL Remove a space in an example URL

Updated schemas to the latest generated by optimade-python-tools (#315)

250a95c

* Updated schemas to the latest generated by optimade-python-tools v0.12.0 Co-authored-by: Casper Welzel Andersen <casper.andersen@epfl.ch>

Migrate CI from Travis to GitHub Actions (#333)

dc980d3

* Added Java tests to GH actions * Renamed GH actions file

Validate OpenAPI schemas in CI with validator.swagger.io (#335)

0938f58

* Added swagger validation using curl/jq and validator.swagger.io * Restructured CI into multiple jobs * Bump pre-commit version as suggested previously * Disabled Travis

Fix incorrect example in assemblies (fixes #317).

a108140

Add field for implementation issue tracker (fixes #337).

05dc9f3

Update optimade.rst

558a71b

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Merge branch 'develop' into add_issue_tracker

afea207

Merge pull request #339 from Materials-Consortia/add_issue_tracker

3cd5936

Add field for implementation issue tracker

Merge branch 'develop' into fix_assemblies_example

1c95024

Merge pull request #338 from Materials-Consortia/fix_assemblies_example

216d7be

Fix incorrect example in assemblies

Added Zenodo citation (#332)

0d1341d

* Added Zenodo citation * Update README.md * Use HTTPS and link to unversioned DOI

Fix spelling errors in specification and update spellcheck tooling (#336

b092c57

) * Sorted allowed word list for cleaner diff * Added new audit tooling for spellchecking * Fixed spelling mistakes in specification and updated .words.lst with 'make fix_spellings'

Redefining 'species'.'mass' as a list of float.

df797e8

Update optimade.rst

e4d795b

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Update optimade.rst

4b6a144

Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>

Merge pull request #344 from merkys/mass-list-of-float

7dadfbc

Redefine species.mass as a list of floats

Updated OpenAPI schemas to those from latest python-tools (v0.12.9) (#…

2b4b77f

…330) * Updated schema to optimade-python-tools v0.12.9

Add link to arXiv paper (#354)

d3d93d5

JPBergsma and others added 4 commits July 7, 2021 15:06

Fixed a grammar error (#373)

afc7bad

Add v1.1.0 schemas from optimade-python-tools v0.16.0 (#370)

7273ba9

* Add v1.1.0 schemas from optimade-python-tools v0.16.0 * Incorporate changes from #367

Bump OPTIMADE version to v1.1.0

1df939b

ml-evs requested review from rartino, CasperWA, merkys, JPBergsma, sauliusg and shyamd July 7, 2021 18:45

ml-evs mentioned this pull request Jul 7, 2021

Bump version number to v1.1.0~develop #374

Closed

JPBergsma reviewed Jul 7, 2021

View reviewed changes

optimade.rst Show resolved Hide resolved

rartino approved these changes Jul 7, 2021

View reviewed changes

merkys approved these changes Jul 8, 2021

View reviewed changes

CasperWA approved these changes Jul 8, 2021

View reviewed changes

ml-evs marked this pull request as draft July 8, 2021 10:44

ml-evs mentioned this pull request Jul 8, 2021

Add CHANGELOG containing release notes #375

Merged

JPBergsma approved these changes Jul 8, 2021

View reviewed changes

ml-evs marked this pull request as ready for review July 8, 2021 15:07

ml-evs merged commit 6f1e115 into master Jul 8, 2021

github-pages bot deployed to github-pages July 8, 2021 15:19 View deployment

ml-evs mentioned this pull request Jul 8, 2021

Swagger OpenAPI validator yields an error #314

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Staging of v1.1.0 #365

Staging of v1.1.0 #365

ml-evs commented Jun 11, 2021 •

edited

Loading

ml-evs commented Jul 7, 2021

rartino commented Jul 7, 2021

rartino left a comment

ml-evs commented Jul 7, 2021

merkys left a comment

rartino commented Jul 8, 2021

ml-evs commented Jul 8, 2021

JPBergsma left a comment •

edited

Loading

ml-evs commented Jul 8, 2021

ml-evs commented Jul 8, 2021

Staging of v1.1.0 #365

Staging of v1.1.0 #365

Conversation

ml-evs commented Jun 11, 2021 • edited Loading

ml-evs commented Jul 7, 2021

rartino commented Jul 7, 2021

rartino left a comment

Choose a reason for hiding this comment

ml-evs commented Jul 7, 2021

merkys left a comment

Choose a reason for hiding this comment

rartino commented Jul 8, 2021

ml-evs commented Jul 8, 2021

JPBergsma left a comment • edited Loading

Choose a reason for hiding this comment

ml-evs commented Jul 8, 2021

ml-evs commented Jul 8, 2021

ml-evs commented Jun 11, 2021 •

edited

Loading

JPBergsma left a comment •

edited

Loading