Skip to content

Commit

Permalink
feat!: Rename package to @vertigis/workflow-activities-arcfm (#43)
Browse files Browse the repository at this point in the history
Update to Node 20
Update to latest Workflow + SDK
Update other deps
Eliminate husky
  • Loading branch information
rcooney authored Apr 15, 2024
1 parent 4d9bc70 commit 1d00d5d
Show file tree
Hide file tree
Showing 9 changed files with 12,799 additions and 8,430 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module.exports = {
extends: [require.resolve("@vertigis/workflow-sdk/config/.eslintrc")],
plugins: ["prettier"],
rules: {},
};
46 changes: 26 additions & 20 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,50 +17,56 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Use Node.js 16
uses: actions/setup-node@v1
- name: Use Node.js 20
uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20.x

- run: npm install

- run: npm run build

- run: npm run lint

- run: cp LICENSE package.json README.md build

- uses: actions/upload-artifact@v3
with:
name: release
path: build/

release:
runs-on: ubuntu-latest
needs:
- test
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/beta'
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
# Pulls all commits (needed for semantic release to correctly version)
# See https://github.com/semantic-release/semantic-release/issues/1526
fetch-depth: "0"
# Pulls all commits and tags (needed for semantic release to correctly version)
fetch-depth: 0
persist-credentials: false
sparse-checkout: |
README.md
# Pulls all tags (needed for semantic release to correctly version)
- name: Fetch git tags
run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*

- name: Use Node.js 16
uses: actions/setup-node@v1
- name: Use Node.js 20
uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 20.x

- run: npm install

- run: npm run build

- run: cp LICENSE package.json README.md build
- name: Download release artifact
uses: actions/download-artifact@v3
with:
name: release
path: release

- name: Release 🚀
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release@^19
working-directory: ./build
run: npx semantic-release@^22
working-directory: ./release
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 VertiGIS North America Ltd.
Copyright (c) 2024 VertiGIS North America Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ArcFM Activities

[![CI/CD](https://github.com/geocortex/workflow-activities-arcfm/workflows/CI/CD/badge.svg)](https://github.com/geocortex/workflow-activities-arcfm/actions)
[![npm](https://img.shields.io/npm/v/@geocortex/workflow-activities-arcfm)](https://www.npmjs.com/package/@geocortex/workflow-activities-arcfm)
[![CI/CD](https://github.com/vertigis/workflow-activities-arcfm/workflows/CI/CD/badge.svg)](https://github.com/vertigis/workflow-activities-arcfm/actions)
[![npm](https://img.shields.io/npm/v/@vertigis/workflow-activities-arcfm)](https://www.npmjs.com/package/@vertigis/workflow-activities-arcfm)

This project contains activities for interacting with the [ArcFM Server REST API](https://resources.arcfmsolution.com/10.2.1d/ServerSDK/webframe.html#topic41788.html) in a [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/).

Expand All @@ -18,16 +18,17 @@ To use the ArcFM activities in [VertiGIS Studio Workflow Designer](https://apps.
- Purpose: `Ready To Use`
- API: `JavaScript`
- URL: The URL to this activity pack manifest
- Use https://unpkg.com/@geocortex/workflow-activities-arcfm/activitypack.json for the latest version
- Use https://unpkg.com/@geocortex/workflow-activities-arcfm@1.2.1/activitypack.json for a specific version
- Use https://unpkg.com/@vertigis/workflow-activities-arcfm/activitypack.json for the latest version
- Use https://unpkg.com/@vertigis/workflow-activities-arcfm@1/activitypack.json for the latest revision of a specific major version
- Use https://unpkg.com/@vertigis/workflow-activities-arcfm@1.0.0/activitypack.json for a specific version
- Title: Your desired title
- Tags: Must include `geocortex-workflow-activity-pack`
1. Reload [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/)
1. The ArcFM activities will now appear in the activity toolbox in a `ArcFM` category

## Development

This project was bootstrapped with the [VertiGIS Studio Workflow SDK](https://github.com/geocortex/vertigis-workflow-sdk). Before you can use your activity pack in the [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/), you will need to [register the activity pack](https://developers.geocortex.com/docs/workflow/sdk-web-overview#register-the-activity-pack).
This project was bootstrapped with the [VertiGIS Studio Workflow SDK](https://github.com/vertigis/vertigis-workflow-sdk). Before you can use your activity pack in the [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/), you will need to [register the activity pack](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview#register-the-activity-pack).

## Available Scripts

Expand All @@ -39,20 +40,16 @@ Interactively generate a new activity or form element.

### `npm start`

Runs the project in development mode. Your activity pack will be available at [http://localhost:5000/main.js](http://localhost:5000/main.js). The HTTPS certificate of the development server is a self-signed certificate that web browsers will warn about. To work around this open [`https://localhost:5000/main.js`](https://localhost:5000/main.js) in a web browser and allow the invalid certificate as an exception. For creating a locally-trusted HTTPS certificate see the [Configuring a HTTPS Certificate](https://developers.geocortex.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate) section on the [VertiGIS Studio Developer Center](https://developers.geocortex.com/docs/workflow/overview/).

### `npm run lint`

Runs linter to perform static analysis.
Runs the project in development mode. Your activity pack will be available at [http://localhost:5000/main.js](http://localhost:5000/main.js). The HTTPS certificate of the development server is a self-signed certificate that web browsers will warn about. To work around this open [`https://localhost:5000/main.js`](https://localhost:5000/main.js) in a web browser and allow the invalid certificate as an exception. For creating a locally-trusted HTTPS certificate see the [Configuring a HTTPS Certificate](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate) section on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/).

### `npm run build`

Builds the activity pack for production to the `build` folder. It optimizes the build for the best performance.

Your custom activity pack is now ready to be deployed!

See the [section about deployment](https://developers.geocortex.com/docs/workflow/sdk-web-overview/#deployment) in the [VertiGIS Studio Developer Center](https://developers.geocortex.com/docs/workflow/overview/) for more information.
See the [section about deployment](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#deployment) in the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/) for more information.

## Documentation

Find [further documentation on the SDK](https://developers.geocortex.com/docs/workflow/sdk-web-overview/) on the [VertiGIS Studio Developer Center](https://developers.geocortex.com/docs/workflow/overview/)
Find [further documentation on the SDK](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/) on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/)
Loading

0 comments on commit 1d00d5d

Please sign in to comment.