diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b38c861714..23bd962e41 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,7 +2,7 @@ name: Locutus CI on: push: branches: - - master + - main pull_request: types: - opened @@ -10,13 +10,13 @@ on: jobs: ci: runs-on: ubuntu-latest - steps : + steps : - uses: actions/checkout@v2 with: fetch-depth: 1 - uses: actions/setup-node@master with: - node-version: 10.x + node-version: 10.x - name: Get yarn cache directory path id : yarn-cache-dir-path run : echo "##[set-output name=dir;]$(yarn cache dir)" @@ -39,16 +39,16 @@ jobs: run : | yarn test - name: Website Build - if : github.ref == 'refs/heads/master' + if : github.ref == 'refs/heads/main' run : | yarn website:install yarn injectweb yarn website:build - name: Website Deploy 🚀 - if : github.ref == 'refs/heads/master' + if : github.ref == 'refs/heads/main' uses: JamesIves/github-pages-deploy-action@3.7.1 - with: + with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} BRANCH : gh-pages # The branch the action should deploy to. FOLDER : website/public # The folder the action should deploy. - CLEAN : true # Automatically remove deleted files from the deploy branch \ No newline at end of file + CLEAN : true # Automatically remove deleted files from the deploy branch diff --git a/CHANGELOG.md b/CHANGELOG.md index 348a94e65c..2a7f8fcbb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,10 +29,10 @@ Ideas that will be planned and find their way into a release at one point - [ ] website: Render authors server-side - [ ] website: Fix the search functionality -## master +## main Released: TBA. -[Diff](https://github.com/locutusjs/locutus/compare/v2.0.16...master). +[Diff](https://github.com/locutusjs/locutus/compare/v2.0.16...main). - [ ] @@ -125,7 +125,7 @@ Released: 2016-05-22. - [x] website: Miscellaneous cosmetic updates - [x] website: Show languages & functions in profile sidebar - [x] website: Add social buttons -- [x] website: Let Travis auto-deploy to gh-pages on master changes +- [x] website: Let Travis auto-deploy to gh-pages on main changes - [x] website: Use Hexo deploy vs bash script ## v2.0.2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ead9a47222..41e7e304ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thank you so much for being or becoming a Locutus contributor! Even if you have write access already, all code changes should be done via a Pull Request. This way we can peer-review, and also GitHub Actions can check if the code adheres to our policies already before -merging it into `master`. +merging it into `main`. ## Contributing Checklist @@ -78,7 +78,7 @@ test/languages/php/array/test-natsort.js ## Website Development -We keep the website in `./website` so it's easy to keep code and website in sync as we iterate. For those reading this screaming murder, [HashiCorp does this](https://github.com/hashicorp/terraform/tree/master/website) for all their projects, and it's working well for them on a scale more impressive than ours. +We keep the website in `./website` so it's easy to keep code and website in sync as we iterate. For those reading this screaming murder, [HashiCorp does this](https://github.com/hashicorp/terraform/tree/HEAD/website) for all their projects, and it's working well for them on a scale more impressive than ours. Our website is built with Hexo. To install the prerequisites type `npm run website:install`. @@ -95,6 +95,6 @@ Blog posts can be found in `website/source/_posts`. If you want to preview locally type `npm run website:start`. -Any change to `master` is deployed automatically onto GitHub Pages by Travis CI via the `travis-deploy.sh` script. +Any change to `main` is deployed automatically onto GitHub Pages by Travis CI via the `travis-deploy.sh` script. Typing `npm run deploy` in the root of the project takes care of all the building steps, and then force pushes the generated HTML to the `gh-pages` branch of this repo. But as mentioned, this should not be necessary as Travis handles it automatically. diff --git a/website/source/_posts/2012-09-26-new-site.md b/website/source/_posts/2012-09-26-new-site.md index e755f1e1d6..c20d5c7e7b 100644 --- a/website/source/_posts/2012-09-26-new-site.md +++ b/website/source/_posts/2012-09-26-new-site.md @@ -19,10 +19,10 @@ and freely available. For instance, you can now very easily: - - [edit the about page](https://github.com/locutusjs/locutus/edit/master/_octopress/source/about/index.markdown) - - [change this blog post](https://github.com/locutusjs/locutus/edit/master/_octopress/source/_posts/2012-09-26-new-site.markdown) - - [checkout the navigation](https://github.com/locutusjs/locutus/blob/master/_octopress/source/_includes/custom/navigation.html) - - [improve the way function pages are built](https://github.com/locutusjs/locutus/blob/master/_octopress/Rakefile#L30) + - [edit the about page](https://github.com/locutusjs/locutus/edit/main/_octopress/source/about/index.markdown) + - [change this blog post](https://github.com/locutusjs/locutus/edit/main/_octopress/source/_posts/2012-09-26-new-site.markdown) + - [checkout the navigation](https://github.com/locutusjs/locutus/blob/main/_octopress/source/_includes/custom/navigation.html) + - [improve the way function pages are built](https://github.com/locutusjs/locutus/blob/main/_octopress/Rakefile#L30) Next, any [Locutus contributor](https://github.com/locutusjs/locutus/graphs/contributors) who has [Octopress set up](https://kvz.io/blog/2012/09/25/blog-with-octopress/) diff --git a/website/source/_posts/2016-04-02-jekyll.md b/website/source/_posts/2016-04-02-jekyll.md index 23c69b659f..998e68b09b 100644 --- a/website/source/_posts/2016-04-02-jekyll.md +++ b/website/source/_posts/2016-04-02-jekyll.md @@ -50,7 +50,7 @@ npm run website:deploy That's it : ) -P.S. We have a few custom build steps such as rendering the functions, that make it hard for us to only use the GitHub Pages provided Jekyll, this means for the time being we'll be relying on our own scripts and Jekyll version. That said, it's still possible to orchestrate auto-deploys whenever there's a change to `master`, by using Travis CI and encrypted environment keys. If I have time, I'd like to set this up too. This way people could propose changes, and merging them would be enough to see them go live. +P.S. We have a few custom build steps such as rendering the functions, that make it hard for us to only use the GitHub Pages provided Jekyll, this means for the time being we'll be relying on our own scripts and Jekyll version. That said, it's still possible to orchestrate auto-deploys whenever there's a change to `main`, by using Travis CI and encrypted environment keys. If I have time, I'd like to set this up too. This way people could propose changes, and merging them would be enough to see them go live. Best wishes, diff --git a/website/source/_posts/2016-05-02-announcing-locutus.md b/website/source/_posts/2016-05-02-announcing-locutus.md index e30a8c30aa..a27db358ab 100644 --- a/website/source/_posts/2016-05-02-announcing-locutus.md +++ b/website/source/_posts/2016-05-02-announcing-locutus.md @@ -7,7 +7,7 @@ thumbnail: /css/images/locutus-alpha.png --- As was briefly mentioned in [Breaking Backwards Compatibility](/blog/2016/04/20/breaking-bc/), -I am launching a big iteration of php.js today. It includes so [many](https://github.com/locutusjs/locutus/pull/291) breaking [changes](https://github.com/locutusjs/locutus/blob/master/CHANGELOG.md#v200) that it is safe to say that, after +I am launching a big iteration of php.js today. It includes so [many](https://github.com/locutusjs/locutus/pull/291) breaking [changes](https://github.com/locutusjs/locutus/blob/main/CHANGELOG.md#v200) that it is safe to say that, after 9 years, php.js is dead. And, like a phoenix, **Locutus** has risen from its ashes. Locutus will largely have the same mission: diff --git a/website/source/about.md b/website/source/about.md index 154f0ac7ae..9fb5522bc6 100644 --- a/website/source/about.md +++ b/website/source/about.md @@ -40,10 +40,10 @@ So, if you know a better way to do something, we would love to see your improvem ## Contributing -We use [GitHub](https://github.com/locutusjs/locutus) for collaboration. There are a few guidelines in our [CONTRIBUTING.md](https://github.com/locutusjs/locutus/blob/master/CONTRIBUTING.md) document. It would be helpful to glance over them before submitting your work, to avoid unnecessary back and forth, as well as potential disappointment. +We use [GitHub](https://github.com/locutusjs/locutus) for collaboration. There are a few guidelines in our [CONTRIBUTING.md](https://github.com/locutusjs/locutus/blob/HEAD/CONTRIBUTING.md) document. It would be helpful to glance over them before submitting your work, to avoid unnecessary back and forth, as well as potential disappointment. ## Licensing Locutus is licensed under the MIT licenses. -[The MIT license](https://github.com/locutusjs/locutus/blob/master/LICENSE) allows you to use the library as you see fit (even in commercial projects) as long as you redistribute the original license along with it. You are not obligated to share your improvements, even though that would obviously be greatly appreciated and would also ensure that you won't lose your changes after you upgrade. +[The MIT license](https://github.com/locutusjs/locutus/blob/HEAD/LICENSE) allows you to use the library as you see fit (even in commercial projects) as long as you redistribute the original license along with it. You are not obligated to share your improvements, even though that would obviously be greatly appreciated and would also ensure that you won't lose your changes after you upgrade. diff --git a/website/themes/icarus/layout/function.ejs b/website/themes/icarus/layout/function.ejs index fa8a355bed..1b64e52088 100644 --- a/website/themes/icarus/layout/function.ejs +++ b/website/themes/icarus/layout/function.ejs @@ -18,11 +18,11 @@ <%- page.content %> [ - View on GitHub + View on GitHub | - Edit on GitHub + Edit on GitHub | - Source on GitHub + Source on GitHub ]
diff --git a/website/themes/icarus/layout/locutus/add_more.ejs b/website/themes/icarus/layout/locutus/add_more.ejs index b93fc19495..9d080b83c2 100644 --- a/website/themes/icarus/layout/locutus/add_more.ejs +++ b/website/themes/icarus/layout/locutus/add_more.ejs @@ -28,7 +28,7 @@
  • Click "New file" in the appropriate folder - on GitHub. + on GitHub. This will fork the project to your account, directly add the file to it, and send a Pull Request to us.