Commit graph

440 commits

Author SHA1 Message Date
John Kleinschmidt
5764d76efa Fix formatting
Add alternate url for security token (depends on whether you are using new or old navigation on VSTS)
2018-07-16 10:39:31 -04:00
John Kleinschmidt
87f34ccda4 Update Windows VS2017 requirement (#13663) 2018-07-13 17:43:27 -05:00
Charles Kerr
3653730cba Add post-publish 'npm dist-tag ls electron' step 2018-07-13 16:17:02 -05:00
John Kleinschmidt
6ea0e73b47
Merge branch 'master' into use-dot-env 2018-07-13 16:02:49 -04:00
Charles Kerr
da92abf964 document ELECTRON_S3_ tokens 2018-07-13 14:42:36 -05:00
Charles Kerr
452b5f342c add note about multiple calls to validateRelease 2018-07-13 14:17:31 -05:00
Charles Kerr
02d072ed9d fix VSTS token generation URL 2018-07-13 13:47:40 -05:00
John Kleinschmidt
6b5ccec0c6 chore: Updates for release process (#13632)
* Fix Appveyor URL

* Update docs to reflect current process

Also added troubleshooting steps.
2018-07-12 07:53:07 -05:00
Zeke Sikelianos
849cddf4be update tokens portion of releasing docs 2018-07-11 11:02:41 -07:00
Jeremy Apthorp
4f8acb0cdd docs: add link to Chromium windows debugging docs
I found this tidbit in particular helpful: 

```sh
> devenv /debugexe out\Debug\chrome.exe <options to Chromium can go here>
```
2018-06-27 23:06:30 +02:00
Samuel Attard
28d148b475
docs: add native_mate to source code directory structure doc (#13451) 2018-06-27 17:46:14 +10:00
Jeremy Apthorp
57d365a9f4 Update build-instructions-windows.md 2018-06-21 12:10:33 -07:00
Vlad Hashimoto
a67c992c36 docs: fix broken link to commit message guidelines (#13233)
* docs: fix broken link  to commit message guidelines

* Fix another broken links
2018-06-15 19:43:03 -05:00
Zeke Sikelianos
cb9ab213bb
Merge pull request #13005 from nornagon/gn-docs
docs: dev instructions for GN build
2018-05-29 15:17:16 -07:00
Maksym Dogadailo
562831ec1a fix tls script path in documentation (#13089) 2018-05-29 03:12:27 -05:00
Jeremy Apthorp
8ea864d6eb docs: dev instructions for GN build 2018-05-24 11:46:35 -07:00
Felix Rieseberg
e8735cc005 docs: Document Python TLS requirements (#12276)
* 🔧 Add simple test script

* 📝 Add documentation

* 🔧 It works, use it

* 🔧 Make the linter happy

* 🔧 Check on bootstrap

* Trivial copyediting

s/operation system/operating system/
2018-05-16 14:19:49 -07:00
Samuel Attard
0bb29e092d
fix: update docs for the ts parser (#12902) 2018-05-12 18:12:28 +10:00
Zeke Sikelianos
1cc5492784
Merge pull request #12870 from electron/remove-macci-refs
Remove references to no longer used https://mac-ci.electronjs.org
2018-05-09 22:25:57 -07:00
John Kleinschmidt
fd8e330760 Remove references to no longer used https://mac-ci.electronjs.org 2018-05-09 16:41:24 -04:00
Charles Kerr
4d078fdb03
Remove more words (#12852)
* remove 'basically' from docs

* remove 'simply' from docs

* remove most uses of 'just' from docs
2018-05-08 00:16:09 -05:00
Shelley Vohr
52e3d5e4f0
remove some beginner-unfriendly terms from docs 2018-05-07 08:46:14 -07:00
Charles Kerr
c81dac774a
Fix some broken documentation links (#12794) 2018-05-02 10:33:07 -05:00
Zeke Sikelianos
1957eb9429 summarize semantic commit requirements (#12665)
* summarize semantic commit requirements

* move semantic commit details into contributing docs

* keep those messages short
2018-05-02 09:47:26 -05:00
Charles Kerr
37a68aebcf Link issues.md back to support.md 2018-04-30 18:06:29 -05:00
Shelley Vohr
f9ee24f8f0
Merge pull request #12627 from vijaypushkin/patch-1
Corrected the name of Capitalization Styles
2018-04-20 09:49:28 -04:00
John Kleinschmidt
717f55b012
Merge pull request #11328 from electron/add-env-to-release-docs
expanded release docs
2018-04-18 11:28:16 -04:00
Vijay Pushkin
82cbd4327f
Corrected the name of Capitalization Styles
Corrected CamelCase to PascalCase and 
mixedCase to camelCase
2018-04-16 13:14:11 +05:30
Charles Kerr
03d119d539
Address @jkleinsc's 2018-03-21 comments 2018-04-13 16:10:53 -05:00
TiagoDanin
d7a003b0bc
📝 Fix dead urls 2018-04-09 17:58:10 -03:00
OJ Kwon
dabd61bf80 chore(build): support generating compilation db (#12104) 2018-04-09 14:54:14 +09:00
Jeremy Apthorp
95cbd69e48 Update testing docs to reflect --grep syntax (#12400)
* Update testing docs to reflect --grep syntax

* Use @zeke's suggestion to s/suites/tests/
2018-03-22 13:19:53 -04:00
bughit
37eccbcd33 Update 3 (of Visual Studio 2017) is leftover from 2015 (#12372)
does not apply to 2017
it's not clear to me that it's possible to download a non current version of vs2017
but if a specific version is required the directions should explain how to get it
2018-03-20 16:15:59 -05:00
Zeke Sikelianos
e3dfffb77b add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
Cheng Zhao
42938de973 Build with Visual Studio 2017 2018-03-20 10:13:16 +03:00
Vanessa Yuen
48dd8f96b7 Fix broken links (#12232)
* Update system-preferences.md

* Fix broken documentation links.
2018-03-14 08:07:36 +09:00
Charles Kerr
35a512310a Merge branch 'master' into add-env-to-release-docs 2018-03-07 16:38:14 +09:00
Charles Kerr
3b2a494033 Update to master. 2018-03-07 16:32:36 +09:00
Nitish Sakhawalkar
dc29b3add1 Add XCode debugging doc 2018-03-06 00:03:14 +05:30
John Kleinschmidt
78ccfa0612
Merge pull request #11879 from electron/fix-gtk-deprecations
Fix GTK+ 3 deprecations
2018-02-16 10:01:01 -05:00
Charles Kerr
4774f32065 replace gtk2 with gtk3 in docs 2018-02-15 15:08:55 -06:00
John Eismeier
8d55334016 Propose fix some typos (#11905) 2018-02-13 00:18:27 -05:00
John Kleinschmidt
12a8d90ef0 Change release process for 2.0
Tag release as soon as version bumps
No longer use release branch
Remove merge step as it is no longer needed.
2018-02-12 14:06:09 -05:00
shelley vohr
533dfc42a8 enhance documentation around contributing to electron (#11887)
* add issues document

* add documentation coding style to doc

* copyediting

* replace `nodejs/node` with `electron/electron`
* fix commasplice
* fix two most important... s/is/are/
* omit unnecessary words

* add pull requests doc

* copyediting

* add general code style to styleguide

* updates to CONTRIBUTING.md

* copyediting

* mark shell blocks as ```sh
* mitigate phrase duplication e.g. 'best practice'
* lots of opinionated changes to omit unnecessary words

* fix numbering & re-apply changes that I overwrote
2018-02-12 08:09:38 -06:00
shelley vohr
647d04cf92 Add brightray to src code structure (#11878)
* add brightray to src code structure

* try new code flag
2018-02-09 13:21:50 -06:00
Vanessa Yuen
4ab13d9e90
Delete upgradeing-chrome.md 2018-02-07 17:11:16 +01:00
John Kleinschmidt
e924781ee5 Improvements to release process
1. Prompt user to verify version before version is created.
2. Fix validateRelease instructions and usage
3. Fix ci-release-build so that you don't have to pass in --ghRelease=true; just --ghRelease will work.
2018-02-05 10:57:48 -05:00
Aleš Pergl
c49cb29ddf Disallow launching unknown apps via browser client.
CVE-2018-1000006
2018-01-22 16:49:30 -06:00
Tiago Danin
74769da9a7 [Docs] Fix URLs and Paths (#11584)
* Fix URLs and Paths in docs/

* Avoiding link break to /docs/development/updgrading-chrome.md

* Fix URLs and Paths in docs/ #2

* Removed double spaces in docs
2018-01-12 10:24:48 -05:00
Felix Rieseberg
5f4b62b6c8 feat: Allow testing of single spec modules (#11409)
* 🔧 ES6 for the spec

* 👷 Allow testing of single modules

* ❤️ Implement feedback

* 📝 Add a testing doc

* 📝 Link to it

* 📝 Cleanup
2017-12-28 06:18:33 -05:00
Cheng Zhao
39ec40b901
Merge pull request #11470 from electron/update-node-upgrade-doc
Update branching steps in upgrading-node.md
2017-12-20 10:08:09 +09:00
Charles Kerr
6f4e97c53a
(copyediting) renumber steps 2017-12-19 09:09:35 -06:00
Cheng Zhao
90582dfa4f
Merge pull request #11154 from electron/update-release-doc
Update release process for API invoked release builds
2017-12-19 15:30:51 +09:00
Shelley Vohr
d602a30bbc
update a few steps in upgrading-node.md 2017-12-12 22:55:37 -05:00
Andrew Scheller
debe77a910
Fix typos 2017-12-13 03:13:41 +00:00
TiagoDanin
079310ab5a
fix formatting in upgrading node doc 2017-12-08 11:49:39 -03:00
TiagoDanin
9314d8925e
fix formatting in upgrading chromium doc 2017-12-08 11:24:05 -03:00
Zeke Sikelianos
fa09ff3cbb update links to versioning doc 2017-12-06 15:01:09 -08:00
Jacob Groundwater
1bce00545d docs: changes based on review 2017-12-05 11:43:59 -08:00
Jacob Groundwater
06371a6082 docs: explain versioning policy 1.x, 2.x, and beyond 2017-12-05 11:38:36 -08:00
Charles Kerr
f0d9b93ede note that 'publish-to-npm' needs node 6 2017-12-05 09:10:26 -06:00
Charles Kerr
f398b5d843 add a tip for testing version number with 'bump-version.py --dry-run' 2017-12-05 08:51:37 -06:00
Charles Kerr
b8259a82c1 note that 'npm run release -- --validateRelease' must be run in release branch 2017-12-05 08:38:16 -06:00
Charles Kerr
7bcea57241 fix tyop 2017-12-04 21:09:12 -06:00
Charles Kerr
3cd6c2e9eb explain using the Electron S3 Bucket environment variables 2017-12-04 20:34:34 -06:00
Charles Kerr
455a61d210 in the npm upload step, explain the needed npm credentials 2017-12-04 20:32:24 -06:00
Charles Kerr
83e94f3de1 fix invocation of validateRelease pass 2017-12-04 20:19:43 -06:00
Charles Kerr
ffdd6ab821 add a troubleshooting note about branch checkout 2017-12-04 10:26:35 -06:00
Charles Kerr
60fe728c0f add section on environment variables 2017-12-04 10:13:22 -06:00
Charles Kerr
b209620514 trim whitespace 2017-12-04 09:51:12 -06:00
Charles Kerr
e5f4916e31 fix numbering of 'Edit the release draft' steps 2017-12-04 09:50:24 -06:00
Charles Kerr
5212b98c87 wrap lines at 80 characters 2017-12-04 09:48:06 -06:00
Charles Kerr
295945b806 copyediting 2017-11-26 08:44:37 +01:00
Charles Kerr
81bc0efc75 fix styleguide errors 2017-11-26 08:38:58 +01:00
Charles Kerr
a75a85449d sync with master 2017-11-26 08:28:27 +01:00
Charles Kerr
22c15082a3 partial doc update from my sprint notes 2017-11-24 14:21:41 +01:00
shelley vohr
6941f93627
Merge pull request #11247 from electron/use_sh_in_docs
prefer `sh` to `bash` in the docs
2017-11-24 11:38:10 +01:00
Charles Kerr
b59557569c oops, the upgrading-chrome.md changes belonged in a separate PR 2017-11-24 11:19:53 +01:00
Charles Kerr
3e3cac6f1b prefer sh to bash in the docs 2017-11-24 11:17:43 +01:00
Shelley Vohr
bd70ec5e97
finalize node upgrade doc 2017-11-24 11:15:07 +01:00
Charles Kerr
1b0c1842ca prefer sh to bash in the docs 2017-11-24 11:13:57 +01:00
Shelley Vohr
ba6224039c
make some things more explicit and style conformity 2017-11-24 11:06:04 +01:00
Shelley Vohr
178462b800
chrome -> chromium and updates to crashpad doc 2017-11-24 10:40:37 +01:00
Charles Kerr
f91020a04d
add section for updating submodule references 2017-11-24 10:40:30 +01:00
Charles Kerr
f8858a7577
add rough draft of node, crashpad update notes 2017-11-24 10:40:21 +01:00
Ales Pergl
19ef7d7a48 Added build dependency information for arm64 2017-11-24 10:58:53 +09:00
Ronald Eddy Jr
7003a2a19c fix continuous-integration build error
Added Missing code-language flags to upgrading-chrome.md
2017-11-22 08:26:23 -08:00
Charles Kerr
5d03f3ca64
Merge pull request #11191 from electron/chromium_updates_guide
Proposed update to Chromium checklist
2017-11-22 08:16:37 +01:00
Zeke Sikelianos
4b41822a62 document chromium_src directory 2017-11-21 10:55:56 -08:00
Catalin Fratila
3b29adc000 Making it prettier. 2017-11-21 15:19:33 +01:00
Charles Kerr
92872154d4
Copyediting 2017-11-21 08:18:12 +01:00
Shelley Vohr
be67fcf62b
initial updates from meeting today 2017-11-20 23:02:54 +01:00
Vanessa Yuen
435e027dc3 fix linting for fenced codeblocks only (see electron/electronjs.org#868) 2017-11-20 14:33:25 +08:00
John Kleinschmidt
3e4b73ef8f Update branch determination 2017-11-17 16:21:14 -05:00
John Kleinschmidt
df891d2aae
Update for API invoked release builds
Also, fixed links
2017-11-17 16:06:42 -05:00
Zeke Sikelianos
f0facdc01f fix formatting in linux build instructions doc 2017-11-11 09:49:19 -08:00
John Kleinschmidt
66846bff97 Automate release (#10827)
* Create prepare-release script

* Add script to merge release

* Cleanup/add logging

* Move release process out of upload.py

* Add cleanup release branch

* Update release doc to reflect new scripts

* Fix to allow running with notesOnly

Also fixup release name and body when beta release.

* Fix issues found during release

* Use getRelease instead of getAssets

github.repos.getAssets is limited to 30 entries which means we may not get back the file we are looking for.

* Documentation corrections
2017-10-23 11:02:50 -04:00
Vanessa Yuen
3208a77bf3 Fix link to version-change-rules 2017-10-17 13:37:05 -04:00
Robin Andersson
c51ac6048d 📝 Updated with link to VS 2015
The previous link pointed to VS 2017 download location.
2017-10-10 21:33:14 +02:00
Zeke Sikelianos
61e606bedc Merge pull request #10336 from electron/document-prereleases
document new release and versioning process
2017-10-06 22:14:42 -07:00
Vanessa Yuen
31eb83223b Update the documentation on the release process to reflect the new versioning policy. 2017-10-06 11:48:09 -04:00
Moetaz
d20ce404ef Update atom-shell-vs-node-webkit.md
nwjs now supports a js script as entrypoint.
cf. http://docs.nwjs.io/en/latest/References/Manifest%20Format/#main
2017-10-04 21:01:39 +02:00
John Kleinschmidt
211688453c Merge pull request #10403 from electron/modify-bump-version
Modify `bump-version.py`
2017-10-03 14:23:33 -04:00
John Kleinschmidt
b77467ca8f Update CI information (#10644)
* Update CI information

* Formatting updates
2017-09-29 16:11:42 -04:00
Zeke Sikelianos
415f1ca3a4 clarify bootstrapping command arg 2017-09-26 21:55:56 -07:00
Zeke Sikelianos
9b6f9a0b18 fix typos in releasing doc 2017-09-26 11:10:29 -07:00
Cheng Zhao
c70508edb1 docs: How to re-upload binaries manually 2017-09-26 10:30:42 +09:00
Cheng Zhao
de4cb9022b Use same -ing form and remove trailing whitespaces 2017-09-26 10:18:38 +09:00
John Schmidt
38342fbe48 📝 Redirect dead link [ci skip] 2017-09-10 08:27:10 -04:00
Vanessa Yuen
4fb800a899 more docs edit 2017-09-06 16:44:41 -04:00
Vanessa Yuen
a81ea1ffde Update release documentation to reflect new usage of bump-version script. 2017-09-06 16:41:51 -04:00
John Kleinschmidt
14eea98566 Merge pull request #10333 from electron/more-releasing-tips
add more releasing tips
2017-08-30 10:42:59 -04:00
Zeke Sikelianos
e1c4962312 add sh to code fences 2017-08-28 08:41:52 -07:00
Tony Ganch
6a285e2e76 Update Chromium Upgrade docs 2017-08-27 17:51:47 +03:00
Aleksei Kuzmin
c4634f7e98 Update Chromium Upgrade docs 2017-08-27 17:51:47 +03:00
Zeke Sikelianos
88b3109137 change backport branch creation steps 2017-08-22 21:03:03 -07:00
Cheng Zhao
a419fe75ca Merge pull request #10253 from electron/improvements-for-libcc-development
Improve development workflow with built libchromiumcontent
2017-08-15 19:40:06 +09:00
Thiago de Arruda
d6fbf5f1bb Improve development workflow with built libchromiumcontent
- Add `--debug_libchromiumcontent` to build libchromiumcontent for debugging
  (shared library build).
- By default, only invoke `gclient sync` the first time to checkout chromium
  source tree. Add `--force_update_libchromiumcontent` switch to force updating.
- Document new options.

The goal is to allow faster edit/compile cycles when debugging/making changes
to libchromiumcontent.
2017-08-15 05:40:22 -03:00
Zeke Sikelianos
fd6aeda6f6 edit release on github after promoting to latest 2017-08-10 20:53:02 -07:00
Zeke Sikelianos
404589d9b5 add more releasing tips 2017-08-10 09:26:22 -07:00
Zeke Sikelianos
e8af45e130 document npm promotion 2017-08-03 13:24:18 -07:00
Zeke Sikelianos
01283c26a8 improve the releasing guide 2017-08-03 12:55:33 -07:00
John Kleinschmidt
b17d34a88c Update with better instructions for building libchromiumcontent 2017-07-28 16:27:33 -04:00
Zeke Sikelianos
c62d1bbf41 improve linux build instructions 2017-07-27 10:29:41 -07:00
Zeke Sikelianos
34c27468dd fix typo in macOS debugging doc 2017-07-17 12:12:44 -07:00
Zeke Sikelianos
57d81f6961 fix typo in linux build instructions 2017-06-19 08:45:06 -07:00
Xaver Hellauer
ded1adf165 Clang-Format extension for Visual Studio Code 2017-05-12 18:40:46 +02:00
Kevin Sawicki
94eff35286 Update docs for new brightray location 2017-05-10 13:42:21 -07:00
Kevin Sawicki
9acd9e878c Mention downloading debugging tools for windows 2017-04-21 08:37:01 -07:00
Kevin Sawicki
740de02d6c builds -> Support 2017-03-30 14:36:52 -07:00
Kevin Sawicki
5b4f715d2e Add test page to check for proprietary codecs 2017-03-30 14:36:52 -07:00
Hari Juturu
d95114016d V8 dev resources (#9008)
* Adding V8 documentation links

* Removing extra space

* use electron markdown conventions

* cross-link v8 and chromium dev docs

* fix v8 link
2017-03-24 15:40:23 -07:00
Zeke Sikelianos
360d2b45f4 document resources for tracking chromium development 2017-03-22 22:59:11 -07:00
Kevin Sawicki
2d638e5da7 Add option to clean.py to only remove dist and out dirs 2017-03-20 10:33:04 -07:00
Adham Saad
8060b0966f 🐛 #8919 - fix typo 2017-03-17 20:47:20 +02:00
Adham Saad
487a195320 🐛 #8919 - add new command to the docs 2017-03-17 20:44:18 +02:00
Zeke Sikelianos
15bf7ed536 use https URLs for images 2017-02-28 21:24:31 -08:00
Kevin Sawicki
de18f09588 Add initial upgrading chrome checklist 2017-02-03 09:54:34 -08:00
Kevin Sawicki
4f6750a460 Update build doc to Xcode 8.2.1 2017-01-24 10:49:42 -08:00
Kevin Sawicki
91c70a66cb Link to Xcode 7.3.1 DMG 2017-01-20 08:16:17 -08:00
Birunthan Mohanathas
b145131505 Mention VS2015 Update 3 to match CI environment 2017-01-20 07:19:43 +02:00
Birunthan Mohanathas
410f3c03d4 Document use of Xcode 7.3.1 with 10.10 SDK for release builds 2017-01-20 07:19:07 +02:00
Phil Wyett
2fbf560668 Commit...
* Update build instructions to correctly reflect python version on CentOS
  that has Python 2.6.
* Correct Fedora package install command. Fedora now uses 'dnf' not 'yum'.
* Add RHEL / CentOS section that does use 'yum' for package install.
2016-12-15 03:05:24 +00:00
Kevin Sawicki
acacb3f551 Update symbols server URL 2016-11-07 10:58:27 -08:00
Kevin Sawicki
e2c646a14b Push after bumping 2016-10-20 11:34:51 +09:00
Zeke Sikelianos
63267031e9 💲 2016-10-20 11:30:36 +09:00
Zeke Sikelianos
88b288502a Add note about Python HTTPS warning 2016-10-20 11:29:02 +09:00
Zeke Sikelianos
b0fb0c6492 Document S3 creds 2016-10-20 11:22:32 +09:00
Zeke Sikelianos
3a44663003 Add note about setting $ELECTRON_GITHUB_TOKEN 2016-10-20 11:19:18 +09:00
Zeke Sikelianos
7a73c0189f bump-release -> bump-version 2016-10-19 11:40:40 +09:00