From 139b048197f705ccd26919813a6728496423b4be Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Fri, 19 Jun 2020 10:25:03 -0600 Subject: [PATCH] Prepare for a new default branch name --- .github/workflows/publish.yml | 2 +- .github/workflows/test.yml | 4 ++-- CONTRIBUTING.md | 10 +++++----- changelog/upgrade-notes.md | 8 ++++---- changelog/v3.5.0.md | 8 ++++---- doc/tutorials/raster-reprojection.md | 10 +++++----- src/ol/format/readme.md | 4 ++-- tasks/changelog.sh | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index cb595fe167..56c182fe92 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,7 +3,7 @@ name: Publish on: push: branches: - - master + - todo-change-to-main jobs: publish-npm: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ed1c8a8591..942d6a54c2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,10 +3,10 @@ name: Test on: push: branches: - - master + - main pull_request: branches: - - master + - main env: CI: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a21314eed6..a29b692030 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to OpenLayers -Thanks for your interest in contributing to OpenLayers. Please see the project's [Code of Conduct](https://github.com/openlayers/openlayers/blob/master/CODE_OF_CONDUCT.md) before proceeding. +Thanks for your interest in contributing to OpenLayers. Please see the project's [Code of Conduct](https://github.com/openlayers/openlayers/blob/main/CODE_OF_CONDUCT.md) before proceeding. ## Asking Questions @@ -21,7 +21,7 @@ Look for `readme.md` files! Several directories contain a `readme.md` file that ## Contributing Code -See [`DEVELOPING.md`](https://github.com/openlayers/openlayers/blob/master/DEVELOPING.md) to learn how to get started developing. +See [`DEVELOPING.md`](https://github.com/openlayers/openlayers/blob/main/DEVELOPING.md) to learn how to get started developing. Our preferred means of receiving contributions is through [pull requests](https://help.github.com/articles/using-pull-requests). Make sure that your pull request follows our pull request guidelines below before submitting it. @@ -31,7 +31,7 @@ This page describes what you need to know to contribute code to OpenLayers as a ## Contributor License Agreement -Your contribution will be under our [license](https://raw.githubusercontent.com/openlayers/openlayers/master/LICENSE.md) as per [GitHub's terms of service](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license). +Your contribution will be under our [license](https://raw.githubusercontent.com/openlayers/openlayers/main/LICENSE.md) as per [GitHub's terms of service](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license). ## Pull request guidelines @@ -103,7 +103,7 @@ Please keep the header line short, no more than 50 characters. ### Be possible to merge automatically -Occasionally other changes to `master` might mean that your pull request cannot +Occasionally other changes to `main` might mean that your pull request cannot be merged automatically. In this case you may need to rebase your branch on a -more recent `master`, resolve any conflicts, and `git push --force` to update +more recent `main`, resolve any conflicts, and `git push --force` to update your branch so that it can be merged automatically. diff --git a/changelog/upgrade-notes.md b/changelog/upgrade-notes.md index 4b93745b56..ec25d84b0b 100644 --- a/changelog/upgrade-notes.md +++ b/changelog/upgrade-notes.md @@ -1448,7 +1448,7 @@ now specify an `extent` instead of `widths`. These settings are used to restrict }); ``` - See https://openlayers.org/en/master/examples/vector-layer.html for a real example. + See https://openlayers.org/en/main/examples/vector-layer.html for a real example. Note that you no longer need to set a `projection` on the source! @@ -1470,7 +1470,7 @@ now specify an `extent` instead of `widths`. These settings are used to restrict The above code uses jQuery to send an Ajax request, but you can obviously use any Ajax library. - See https://openlayers.org/en/master/examples/igc.html for a real example. + See https://openlayers.org/en/main/examples/igc.html for a real example. * Note about KML @@ -1528,9 +1528,9 @@ now specify an `extent` instead of `widths`. These settings are used to restrict }); ``` - See https://openlayers.org/en/master/examples/vector-osm.html for a real example. + See https://openlayers.org/en/main/examples/vector-osm.html for a real example. -* The experimental `ol.loadingstrategy.createTile` function has been renamed to `ol.loadingstrategy.tile`. The signature of the function hasn't changed. See https://openlayers.org/en/master/examples/vector-osm.html for an example. +* The experimental `ol.loadingstrategy.createTile` function has been renamed to `ol.loadingstrategy.tile`. The signature of the function hasn't changed. See https://openlayers.org/en/main/examples/vector-osm.html for an example. #### Change to `ol.style.Icon` diff --git a/changelog/v3.5.0.md b/changelog/v3.5.0.md index f28dbf0150..a1d3138a59 100644 --- a/changelog/v3.5.0.md +++ b/changelog/v3.5.0.md @@ -53,7 +53,7 @@ The 3.5.0 release includes features and fixes from a whopping 129 pull requests }); ``` - See https://openlayers.org/en/master/examples/vector-layer.html for a real example. + See https://openlayers.org/en/main/examples/vector-layer.html for a real example. Note that you no longer need to set a `projection` on the source! @@ -75,7 +75,7 @@ The 3.5.0 release includes features and fixes from a whopping 129 pull requests The above code uses jQuery to send an Ajax request, but you can obviously use any Ajax library. - See https://openlayers.org/en/master/examples/igc.html for a real example. + See https://openlayers.org/en/main/examples/igc.html for a real example. * Note about KML @@ -133,9 +133,9 @@ The 3.5.0 release includes features and fixes from a whopping 129 pull requests }); ``` - See https://openlayers.org/en/master/examples/vector-osm.html for a real example. + See https://openlayers.org/en/main/examples/vector-osm.html for a real example. -* The experimental `ol.loadingstrategy.createTile` function has been renamed to `ol.loadingstrategy.tile`. The signature of the function hasn't changed. See https://openlayers.org/en/master/examples/vector-osm.html for an example. +* The experimental `ol.loadingstrategy.createTile` function has been renamed to `ol.loadingstrategy.tile`. The signature of the function hasn't changed. See https://openlayers.org/en/main/examples/vector-osm.html for an example. ### Change to `ol.style.Icon` diff --git a/doc/tutorials/raster-reprojection.md b/doc/tutorials/raster-reprojection.md index 167d25f353..5dc3d676d0 100644 --- a/doc/tutorials/raster-reprojection.md +++ b/doc/tutorials/raster-reprojection.md @@ -39,10 +39,10 @@ var map = new Map({ If a source (based on `ol/source/TileImage` or `ol/source/Image`) has a projection different from the current `ol/View`’s projection then the reprojection happens automatically under the hood. ### Examples -- [Raster reprojection demo](https://openlayers.org/en/master/examples/reprojection.html) -- [OpenStreetMap to WGS84 reprojection](https://openlayers.org/en/master/examples/reprojection-wgs84.html) -- [Reprojection with EPSG.io database search](https://openlayers.org/en/master/examples/reprojection-by-code.html) -- [Image reprojection](https://openlayers.org/en/master/examples/reprojection-image.html) +- [Raster reprojection demo](https://openlayers.org/en/main/examples/reprojection.html) +- [OpenStreetMap to WGS84 reprojection](https://openlayers.org/en/main/examples/reprojection-wgs84.html) +- [Reprojection with EPSG.io database search](https://openlayers.org/en/main/examples/reprojection-by-code.html) +- [Image reprojection](https://openlayers.org/en/main/examples/reprojection-image.html) ### Custom projection The easiest way to use a custom projection is to add the [Proj4js](http://proj4js.org/) library to your project and then define the projection using a proj4 definition string. It can be installed with @@ -125,7 +125,7 @@ Although this is mathematically correct behavior of the inverse transformation, A possible general solution would be to calculate the forward transformation for every vertex as well - but this would significantly decrease performance (especially for computationally expensive transformations). Therefore a recommended workaround is to define a proper visibility extent on the `ol.layer.Tile` in the view projection. -Setting such a limit is demonstrated in the [reprojection demo example](https://openlayers.org/en/master/examples/reprojection.html). +Setting such a limit is demonstrated in the [reprojection demo example](https://openlayers.org/en/main/examples/reprojection.html). ### Resolution calculation When determining source tiles to load, the ideal source resolution needs to be calculated. diff --git a/src/ol/format/readme.md b/src/ol/format/readme.md index 7bba8e2155..7023f3ab07 100644 --- a/src/ol/format/readme.md +++ b/src/ol/format/readme.md @@ -51,7 +51,7 @@ There are two key concepts to master to understand how `ol/xml` works: * How `ol/xml~parse` traverses the XML document (or node) and calls back to your code * How `ol/xml` decouples the structure of the XML document (which is always a tree) from the structure of the output data (which could be a single object, an array of objects, or anything else) using an object stack. -It's handy to have the [`src/ol/xml.js` source code](https://github.com/openlayers/openlayers/blob/master/src/ol/xml.js) to hand while you read the following. +It's handy to have the [`src/ol/xml.js` source code](https://github.com/openlayers/openlayers/blob/main/src/ol/xml.js) to hand while you read the following. ## How `ol/xml~parse` traverses the XML document @@ -124,7 +124,7 @@ In the above there are many common operations, like setting the property of the ### Putting it all together -With the above, you should be able to read through the [source code to `ol/format/GPX`](https://github.com/openlayers/openlayers/blob/master/src/ol/format/gpxformat.js) and get a feel for how it works. Start from the bottom of the file and work upwards. It's also useful to have [an example GPX file](http://www.topografix.com/fells_loop.gpx) and [the GPX specification](http://www.topografix.com/GPX/1/1/) to hand. +With the above, you should be able to read through the [source code to `ol/format/GPX`](https://github.com/openlayers/openlayers/blob/main/src/ol/format/gpxformat.js) and get a feel for how it works. Start from the bottom of the file and work upwards. It's also useful to have [an example GPX file](http://www.topografix.com/fells_loop.gpx) and [the GPX specification](http://www.topografix.com/GPX/1/1/) to hand. ### Handling errors diff --git a/tasks/changelog.sh b/tasks/changelog.sh index 0b36ace450..9efd05126a 100755 --- a/tasks/changelog.sh +++ b/tasks/changelog.sh @@ -38,7 +38,7 @@ EOF # # Scan the git log for merge commit messages and output Markdown. This only # follows the first parent of merge commits to avoid merges within a topic -# branch (instead only showing merges to master). +# branch (instead only showing merges to main). # main() { git log --first-parent --format='%aN|%s %b' ${1} |