Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

99 lines (61 loc) · 2.27 KB
Raw

When contributing to this repository, please check the issues first, and post a new one if relevant.

📥 Get the source code

  1. Fork this repository 🍴

  2. Clone the forked repository (change the URL of the git clone for yours)

git clone https://github.com/vemonet/setup-spark.git
cd setup-spark
  1. Create a new branch from the main branch, and go to this branch 🕊️
git checkout -b my-branch

👩‍💻 Development

Checkout the only important file! The mighty src/setup-spark.ts ✨. The Spark installation has been inspired by the jupyter/docker-stack pyspark Dockerfile

  1. Install dependencies:
npm install
  1. Build the dist/index.js file with vercel/ncc:
npm run build
  1. Commit and push the generated dist/index.js file with the rest of the modified files

☑️ Test

We use the test.yml GitHub Actions workflow in .github/workflows to test setting up Spark versions. If you are making a substantive change try to link to a successful run that utilizes the changes you are working on.

Install act to test running the action locally:

act -j test-setup-spark-scala
# Build and run act:
npm run dev

Format the code with prettier:

npm run fmt

Run eslint checks:

npm run test

Third party dependencies licenses are checked automatically by a GitHub Action workflow using Licensed.

🔼 Updating dependencies

Update dependencies to latest version:

npm update

Check for vulnerabilities:

npm audit

Fix dependencies with vulnerabilities:

npm audit fix --force

Commit, push and check if the GitHub action tests are passing.

🏷️ Publish new version

  1. Update version in package.json

  2. Create a new release on GitHub for this new tag

  3. Then update the v1 tag to the latest commit (v1 should always be sync to the latest version)

    npm run release