Skip to content

Commit

Permalink
delete meta folder
Browse files Browse the repository at this point in the history
  • Loading branch information
vemonet committed Jul 22, 2023
1 parent e54485d commit a02b892
Show file tree
Hide file tree
Showing 32 changed files with 25 additions and 2,487 deletions.
32 changes: 4 additions & 28 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
run: npm install

# - name: Lint
# run: npm run fmt-check
# run: npm run lint

- name: Run setup-spark ${{ matrix.versions.spark }}
uses: ./
Expand Down Expand Up @@ -98,46 +98,24 @@ jobs:

CodeQL-analysis:
name: 🔎 CodeQL analysis
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
language: ['javascript']

# CodeQL runs on ubuntu-latest and windows-latest
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# languages: go, javascript, csharp, python, cpp, java

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2



check-license:
name: 📜 Check licenses
runs-on: ubuntu-latest
Expand All @@ -146,8 +124,6 @@ jobs:
- run: npm ci
- name: Install licensed
run: |
cd $RUNNER_TEMP
curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.1.0/licensed-3.1.0-linux-x64.tar.gz
sudo tar -xzf licensed.tar.gz
sudo mv licensed /usr/local/bin/licensed
- run: licensed status
tar -xzf licensed.tar.gz
- run: ./licensed status
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
node_modules/
__tests__/runner/*

# Licensed
meta/

# Ignore js files that are transpiled from ts files in src/
lib/

Expand Down
36 changes: 15 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,18 @@ cd setup-spark
git checkout -b my-branch
```

## 👩‍💻 How to contribute
## 👩‍💻 Development

Checkout the only important file! The mighty [`src/setup-spark.ts`](https://github.com/vemonet/setup-spark/blob/main/src/setup-spark.ts)

The Spark installation has been built based on the [jupyter/docker-stack PySpark notebook Dockerfile](https://github.com/jupyter/docker-stacks/blob/master/pyspark-notebook/Dockerfile)

In order to avoid uploading `node_modules/` to the repository, we use [vercel/ncc](https://github.com/vercel/ncc) to create a single `index.js` file that gets saved in `dist/`.

### Development

1. Install with [Licensed](https://github.com/github/licensed) to check dependencies:
1. Install:

```bash
npm install
wget -O licensed.tar.gz https://github.com/github/licensed/releases/download/3.1.0/licensed-3.1.0-linux-x64.tar.gz
tar -xzf licensed.tar.gz && rm -f licensed.tar.gz
```

2. Build the `index.js` file:
Expand All @@ -45,47 +41,39 @@ This also generates the javascript files from TypeScript files. Any files genera

3. Commit and push the generated `index.js` file with the rest of the modified files

### Testing
## ☑️ Test

We use the `test-setup-spark.yml` GitHub Actions workflow in `.github/workflows` to test setting up Spark versions
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.

If you are making a substantive change try to link to a successful run that utilizes the changes you are working on.

You can use [`act`](https://github.com/nektos/act) to test running the action locally:
Install [`act`](https://github.com/nektos/act) to test running the action locally:

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

Format:
Format the code with prettier:

```bash
npm run fmt
```

### Pull request process

1. Before sending a pull request, make sure the project still work as expected with the new changes properly integrated
2. [Send a pull request](https://github.com/vemonet/setup-spark/compare) to the `main` branch 📤
3. Project contributors will review your change, and answer the pull request as soon as they can

## 📜 Check dependencies licenses

This repository uses a tool called [Licensed](https://github.com/github/licensed) to verify third party dependencies.

Download licensed on Linux:
[Download licensed](https://github.com/github/licensed/releases/download/3.1.0/licensed-3.1.0-linux-x64.tar.gz):

```bash
wget -O licensed.tar.gz https://github.com/github/licensed/releases/download/3.1.0/licensed-3.1.0-linux-x64.tar.gz
curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/3.1.0/licensed-3.1.0-linux-x64.tar.gz
tar -xzf licensed.tar.gz && rm -f licensed.tar.gz
```

Run `licensed` locally and generate the license dependencies in `.licenses` use:

```bash
./licensed cache
npm run licensed
```

If you have not licensed installed, this is not a problem, we will do it the next time we pull the changes.
Expand All @@ -112,6 +100,12 @@ npm audit fix --force

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

## 🕊️ Pull request process

1. Before sending a pull request, make sure the project still work as expected with the new changes properly integrated
2. [Send a pull request](https://github.com/vemonet/setup-spark/compare) to the `main` branch 📤
3. Project contributors will review your change, and answer the pull request as soon as they can

## 🏷️ Publish new version

Create a new release on GitHub following semantic versioning, e.g. `v1.2.0`
Expand Down
213 changes: 0 additions & 213 deletions meta/.licenses/bundler/addressable.dep.yml

This file was deleted.

0 comments on commit a02b892

Please sign in to comment.