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

Release some stable versions + bump XML namespaces #22

Closed
wrygiel opened this issue May 25, 2017 · 4 comments
Closed

Release some stable versions + bump XML namespaces #22

wrygiel opened this issue May 25, 2017 · 4 comments
Assignees

Comments

@wrygiel
Copy link
Contributor

wrygiel commented May 25, 2017

@erasmus-without-paper/all-members

1.0.0 versions of IIAs API and IIA CNR API

I think it's time to release the stable versions of IIAs API and IIA CNR API. I can see that many partners have already implemented IIAs API, so I guess they have also cross-validated the specifications, and we may consider them stable. IIA CNR API hasn't been implemented, but I think we can make it stable too (because these two are much related).

Bump all other XML namespaces to stable-v1?

Quote from the Working with EWP Technical Documentation document (version 1.2.0). This was changed recently:

Unreleased (draft) APIs also SHOULD use valid GitHub URLs for theirs XML
namespaces. They MAY use URLs referring to the master branch, but they
also MAY use URLs referring to the - not yet existing - stable-v1 branch
(for forward-compatibility). This DOES NOT mean that you can have draft
changes in stable-v1 branch - it only means that you can use stable-v1
XML namespace in your master branch.

In fact, I now think it was a bad decision to have master XML namespaces in the beginning. We should have started with stable-v1, not master. Note, that this does not prevent us from introducing backward-incompatible things in 0.x.y versions. It does however allow us to migrate from 0.x.y version to 1.0.0 version without much of a hassle.

That said, I think it might be a good idea to perform this action now (changing master to stable-v1 in all XML namespaces), without marking the APIs themselves as stable yet (they will still be 0.x.y). This, of course, would break some implementations, so we should schedule some specific date for that action (we would ask all developers to switch to the new namespace on this date). When would be a good time for that?

@wrygiel wrygiel self-assigned this May 25, 2017
@wrygiel
Copy link
Contributor Author

wrygiel commented May 26, 2017

When would be a good time for that?

I propose 12th of June (2017-06-12). @erasmus-without-paper/all-members, will this be okay with you? I would push these changes to all repositories either on this day, or a couple of days earlier.

@georgschermann
Copy link

ok for us

@mkurzydlowski
Copy link
Contributor

OK :)

wrygiel added a commit to erasmus-without-paper/ewp-specs-api-courses that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-course-replication that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-iia-cnr that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-imobility-tors that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-omobilities that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-api-omobility-cnr that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
wrygiel added a commit to erasmus-without-paper/ewp-specs-fileext-ewpmobility that referenced this issue Jun 12, 2017
This action is performed on *all* active EWP repositories as part of:
erasmus-without-paper/ewp-specs-api-iias#22
@wrygiel
Copy link
Contributor Author

wrygiel commented Jun 12, 2017

Quote from email we just sent.

As we previously announced, today (or - at the latest - before the end of this week), we expect all EWP developers to change all XML namespaces in their implementations of draft APIs from master to stable-v1.

  • For most developers, this step should be easy - you just need to find all occurrences of master in your project and replace those with stable-v1.

  • If possible, then you should also bump API versions in your manifest.xml files.

We have released new 0.x.y versions of all draft APIs. Currently, none of them have master in their XML namespaces.

@wrygiel wrygiel closed this as completed Jun 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants