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

Automated preview instances of iD for tagging PRs #800

Merged
merged 5 commits into from Mar 13, 2023

Conversation

tyrasd
Copy link
Member

@tyrasd tyrasd commented Feb 25, 2023

Closes #289.
Example of how it will look like: tyrasd#3.

Currently, this has some small limitations:

  • Uploading changes is not possible in these test instances, because OSM's Oauth2 setup does not allow wildcard subdomains for the redirect URI. I think that's fine, since these test instances are only meant for testing the tagging PRs, and not intended for editing.
  • New strings will now show up when using a locale other than English

To do:

  • set secrets to deploy on netlify (NETLIFY_AUTH_TOKEN, NETLIFY_SITE_ID)
  • drop action artifacts after deployment

PS: This is very much "inspired" by the implementation made in the openlayers.

@tyrasd tyrasd closed this Feb 25, 2023
@tyrasd tyrasd reopened this Feb 25, 2023
@tyrasd tyrasd marked this pull request as draft February 25, 2023 12:50
@tyrasd tyrasd changed the title [wip] preview [wip] PR previews Feb 25, 2023
@tyrasd tyrasd force-pushed the build-preview branch 2 times, most recently from 4ca2c5a to 7774e92 Compare February 25, 2023 14:38
@tyrasd tyrasd changed the title [wip] PR previews Automated preview instances of iD for tagging PRs Feb 25, 2023
@tyrasd tyrasd added enhancement New feature or request ci labels Feb 25, 2023
@tyrasd tyrasd force-pushed the build-preview branch 3 times, most recently from d834346 to 22ebd15 Compare February 25, 2023 15:41
@tordans
Copy link
Collaborator

tordans commented Mar 3, 2023

New strings will now show up when using a locale other than English

Could you change the preview URL that the bot comments to include ?locale=en (this was the param, right?), so the translation issue is only visible if users force it to?

@tordans
Copy link
Collaborator

tordans commented Mar 3, 2023

Also, I assume that openstreetmap/openstreetmap-website#3955 (comment) is a big +1 that this feature is a good idea, right?

@tordans
Copy link
Collaborator

tordans commented Mar 3, 2023

This looks great and the PR you linked works as I would expect.

The article I linked at https://github.com/openstreetmap/id-tagging-schema/pull/800/files#r1124938112 had some hints at how to maybe speed up the npm install further with some caching stuff, but I don't know if that would be relevant (enough) for this use case.

This will be a great improvement.

One thing that should likely be part of the PR is an update to the Readme on how to contribute and use this new feature.

@tyrasd tyrasd marked this pull request as ready for review March 13, 2023 11:58
@tyrasd
Copy link
Member Author

tyrasd commented Mar 13, 2023

One thing that should likely be part of the PR is an update to the Readme on how to contribute and use this new feature.

What exactly did you have in mind which should be mentioned in the Readme? As the bot automatically posts a comment directly on each PR, the contributors don't have to do anything manually and the message in the posted comment should be sufficiently "documenting" what it is about?! So, basically I don't know what exactly to put into the readme. ☺️ If you can suggest some lines to be added to the Readme, I'd be very happy to add them, though.

@tyrasd tyrasd merged commit f7a2cd2 into openstreetmap:main Mar 13, 2023
@tyrasd tyrasd deleted the build-preview branch March 13, 2023 12:07
tyrasd added a commit to openstreetmap/iD that referenced this pull request Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

An easy way to preview presets from PRs in iD
2 participants