Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dpogue/seymour

A build helper for Apache Cordova projects.
https://github.com/dpogue/seymour

cordova hacktoberfest

Last synced: about 2 months ago
JSON representation

A build helper for Apache Cordova projects.

Host: GitHub
URL: https://github.com/dpogue/seymour
Owner: dpogue
License: apache-2.0
Created: 2015-11-12T00:25:18.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-10-21T04:43:38.000Z (2 months ago)
Last Synced: 2024-11-01T08:42:24.752Z (about 2 months ago)
Topics: cordova, hacktoberfest
Language: JavaScript
Homepage: https://www.npmjs.com/package/seymour
Size: 2.12 MB
Stars: 16
Watchers: 6
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

Seymour
=======

Seymour is a build helper for [Apache Cordova](https://cordova.apache.org)
projects.

It takes configuration from environment variables, making it ideal for use in
continuous integration environments with a matrix of platforms and build types.

Usage
-----

Install Seymour:

```
npm install --save-dev seymour
```

Run Seymour on your Cordova project:

```
npx seymour
```

How it works
------------

Seymour requires your Cordova platforms and plugins to be listed in your
config.xml file. It will effectively run the following:

```
cordova prepare
cordova build --device
```

You can control additional behaviour through environment variables.

To update the config.xml file without running a build, you can run Seymour with
the `--config-only` flag.

### Future Features

* Collect the resulting build artefacts into a top-level `output` directory

Configuration
-------------

The following environment variables will be used by Seymour to alter the
resulting build:

### SEY_BUILD_MODE

* **Valid options:** `debug`, `release`
* **Default value:** `debug`

### SEY_BUILD_PLATFORMS

* **Valid options:** A comma-separated list of Cordova platforms to build
* **Default value:** Use the platforms listed in config.xml

You cannot use this to add new platforms that are not listed in config.xml. You
can only use this to restrict to a subset of platforms.

### SEY_BUILD_CONFIG

The name of a JSON file containing build signing information.

See the following Cordova documentation for JSON options:
* [Android](http://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html#using-buildjson)
* [iOS](http://cordova.apache.org/docs/en/latest/guide/platforms/ios/index.html#using-buildjson)
* [Windows](http://cordova.apache.org/docs/en/latest/guide/platforms/win8/index.html#signing-an-app)

### SEY_BUILD_NUMBER

This will override the build version number (not the application version)
defined in config.xml.

This corresponds to the iOS `CFBundleVersion` and the Android `versionCode`.

### SEY_APP_NAME

This will override the application name defined in config.xml.

### SEY_APP_SHORTNAME

This will override the application display name defined in config.xml.

### SEY_APP_ID

This will override the application identifier defined in config.xml.

### SEY_APP_VERSION

This will override the application version defined in config.xml.

### SEY_VERBOSE

This will enable verbose logging from the Cordova build commands.

### SEY_PREFERENCE_*

This will allow you to set and override preferences globally in config.xml.

For example, you could specify `SEY_PREFERENCE_backgroundColor=FF0000FF` to
override the `backgroundColor` preference in config.xml.

### SEY_\*\_PREFERENCE\_\*

This will allow you to set and override platform specific preferences in config.xml.

For example, you could specify `SEY_IOS_PREFERENCE_SasApiKey=123456789` to
override the `SasApiKey` preference nested in the ios platform in config.xml.

Contributing
------------

Contributions of bug reports, feature requests, and pull requests are greatly appreciated!

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/dpogue/seymour/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

Licence
-------