Skip to content

Commit 39c2799

Browse files
authored
doc: update nightly builds page (#1435)
1 parent 458e505 commit 39c2799

File tree

1 file changed

+71
-46
lines changed

1 file changed

+71
-46
lines changed

www/contribute/nightly_builds.md

Lines changed: 71 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,71 @@
1-
---
2-
layout: contribute
3-
title: Apache Cordova Nightly Builds
4-
---
5-
6-
# Nightly builds
7-
8-
**These are not official releases.**
9-
10-
Cordova community provides Cordova nightly builds as a way to test new features and bug-fixes not yet included into the latest official release. Nightly builds are performed by [Apache Jenkins](https://builds.apache.org/view/A-D/view/Cordova/job/cordova-nightly/) every day approximately at 3PM UTC and are being published to NPM under the `@nightly` dist tag.
11-
12-
The following NPM packages are being released as a part of the nightly builds:
13-
- cordova
14-
- cordova-lib
15-
- cordova-android
16-
- cordova-ios
17-
- cordova-windows
18-
19-
## Notice
20-
21-
The nightly builds are untested and may contain known and unknown defects, undeclared features, and perhaps other issues. They are intended to be used for testing purposes by developers, and others who want to help with resolving bugs.
22-
23-
## Installation
24-
25-
To try out the latest nightly version you can do:
26-
27-
```bash
28-
npm install cordova@nightly
29-
./node_modules/.bin/cordova --version
30-
```
31-
32-
You can supply the `--global` option to NPM to install the nightly version globally. _Note_ that this will replace your main Cordova distribution.
33-
34-
```bash
35-
npm install --global cordova@nightly
36-
```
37-
38-
## Submitting issues
39-
40-
Please let us know about any issues in the nightly builds so we can fix them as soon as possible. For submitting issues, please refer to the [Reporting Issues](./issues.md) document.
41-
42-
When submitting an issue, please add a note that the issue was reproduced using a nightly build, and provide the nightly version that you are using. You can get this via:
43-
44-
```bash
45-
cordova --version
46-
```
1+
---
2+
layout: contribute
3+
title: Apache Cordova Nightly Builds
4+
---
5+
6+
# Nightly builds
7+
8+
**Nightly builds are not official releases and should not be used in production.**
9+
10+
They are generated and published to the NPM registry around 3 PM UTC under the `@nightly` dist tag.
11+
12+
The following NPM packages are being released as a part of the nightly builds:
13+
14+
- cordova (cordova-cli)
15+
- cordova-lib
16+
- cordova-common
17+
- cordova-fetch
18+
- cordova-serve
19+
- cordova-create
20+
- xcode (cordova-node-xcode)
21+
- cordova-android
22+
- cordova-electron
23+
- cordova-ios
24+
25+
## Notice
26+
27+
Nightly builds are intended for testing purposes only—such as trying out unreleased features, verifying bug fixes, or identifying new issues before an official release.
28+
29+
These builds are created daily from the main branch and may be **unstable**. They are untested, may contain known and unknown defects, undeclared features, and perhaps other issues.
30+
31+
## Installing Cordova CLI Nightly Builds
32+
33+
The Cordova CLI nightly build can be installed either locally (project scope) or globally.
34+
35+
### Install locally (project scope):
36+
37+
```zsh
38+
npm install cordova@nightly
39+
npx cordova --version
40+
```
41+
42+
### Install globally:
43+
44+
```zsh
45+
npm install -g cordova@nightly
46+
cordova
47+
```
48+
49+
> **Note:** Installing globally will replace any existing Cordova installation.
50+
51+
## Installing Cordova Platform Nightly Builds
52+
53+
Cordova CLI uses npm to install platforms and plugins, as they are distributed as npm packages. To install a nightly build of a platform, simply append the `@nightly` tag to the platform name in the `platform add` command.
54+
55+
For example:
56+
57+
```zsh
58+
cordova platform add ios@nightly
59+
```
60+
61+
## Submitting Issues
62+
63+
If you encounter any issues with the nightly builds, please report them to the appropriate GitHub repository.
64+
65+
For details on how to report issues, see the [Reporting Issues](./issues.md) guide.
66+
67+
When submitting, **mention that the issue occurred using a nightly build** and include the version by running:
68+
69+
```bash
70+
cordova --version
71+
```

0 commit comments

Comments
 (0)