Skip to content

Commit

Permalink
Small bugfixes & enhancements, improvements for deployments, director…
Browse files Browse the repository at this point in the history
…ies, and docs (#259)

* Fixed #253 by adding a filter on NamespacePrefix when querying ApexClass - previously, the tests could have failed if an org had 2 classes with the same name (1 with, and 1 without a namespace)

* Fixed #257 - Moved security check tests to a separate test class, under extra-tests directory

* Fixed #256 by adding a few extra null/isBlank() checks

* Shortened the label for the field LogEntry__c.TransactionEntryNumber__c

* Moved 'streaming/paused' btn in logEntryEventStream.html

* Moved constants to top of LogEntryBuilder

* Shifted around the metadata for the Slack plugin to better match the core package's folder structure. This will make it easier to consolidate the folders in orgs that deploy the unpackaged metadata (instead of using the unlocked package)

* Added missing @param tags for JSDoc in logger.js

* Consolidated several top-level directories to all be under the directories `nebula-logger` and `config`

* Renamed `content` folders to `images`

* Updated package aliases in sfdx-project.json, moved apexdocs config files, consolidated apex & lwc coverage files into `test-coverage` directory

* Readded some deprecated metadata to the managed-package folder, and added deploy action for generating a beta managed package version
Currently, deprecating metadata isn't available for managed packages (unless you opt in to a pilot feature, and I have not done so yet)

* Switched to new pwsh script create-and-install-package-version.ps1 for pipeline
This version of the script is fully generic - the package alias, README path, and target username can be passed as parameters, and sfdx-project.json is then parsed for other details, like version number & path

* Improved packaging process & pwsh scripts for the managed package, improved an integration test for Experience Cloud

* Added --branch and --tag parameters to package creation pwsh scripts

* Removed some old pwsh scripts, renamed a few others

* Fixed `prepare` npm script to use npx sfdx

* Regenerated a clean copy of package-lock.json

* Removed jsconfig.json files

* Added CODE_OF_CONDUCT.md, based on v2.0 of the Contributor Covenant
  • Loading branch information
jongpie authored Jan 6, 2022
1 parent 166dd93 commit 7c0af6e
Show file tree
Hide file tree
Showing 782 changed files with 12,950 additions and 13,212 deletions.
6 changes: 4 additions & 2 deletions .forceignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
#

nebula-logger/main/default/**
nebula-logger/**/main/default/
nebula-logger/managed-package/sfdx-project.json
nebula-logger/managed-package/**/testSuites/**

# Directory/package-specific README files
**/README.md
**/.content/**
**/images/**

# LWC configuration files
**/jsconfig.json
Expand Down
File renamed without changes.
47 changes: 42 additions & 5 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ jobs:

# TODO revisit this part - for now, CodeCov.io upload will only run in the Experience Cloud org
- name: 'Delete unsupported code coverage files'
run: rm ./tests/apex/test-result-707*-codecoverage.json
run: rm ./test-coverage/apex/test-result-707*-codecoverage.json

- name: 'Upload Apex test code coverage to Codecov.io'
uses: codecov/[email protected]
Expand All @@ -229,10 +229,10 @@ jobs:
run: npm run org:delete:noprompt
if: ${{ always() }}

create-and-install-package-version:
name: 'Create & Install Package Version'
create-unlocked-package-release-candidate:
name: 'Create Core Package Release Candidate'
needs: [lwc-tests, base-scratch-org-tests, experience-cloud-scratch-org-tests]
if: ${{ github.event_name == 'pull_request' }}
if: ${{ github.ref != 'refs/heads/main' }}
runs-on: ubuntu-latest
environment: Test
steps:
Expand Down Expand Up @@ -272,7 +272,7 @@ jobs:
PKG_DEMO_ORG_SFDX_URL: ${{ secrets.NEBULA_PKG_DEMO_SANDBOX_SFDX_URL }}

- name: 'Create & Install Package Version'
run: npx pwsh ./scripts/build/create-and-install-package-version.ps1 -targetusername nebula-logger-package-demo
run: npx pwsh ./config/scripts/build/create-and-install-package-version.ps1 -targetpackagealias '"Nebula Logger - Core"' -targetreadme ./README.md -targetusername nebula-logger-package-demo

- name: 'Commit New Package Version'
run: |
Expand All @@ -282,3 +282,40 @@ jobs:
git add ./sfdx-project.json
git commit -m "Created new package version"
git push
create-managed-package-beta:
name: 'Create Managed Package Beta'
needs: [lwc-tests, base-scratch-org-tests, experience-cloud-scratch-org-tests]
if: ${{ github.ref != 'refs/heads/main' }}
runs-on: ubuntu-latest
environment: Test
steps:
- name: 'Checkout source code'
uses: actions/checkout@v2
with:
ref: ${{ github.event.pull_request.head.ref }}

- name: 'Restore node_modules cache'
id: cache-npm
uses: actions/cache@v2
with:
path: node_modules
key: npm-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
npm-${{ env.cache-name }}-
npm-
- name: 'Install npm dependencies'
if: steps.cache-npm.outputs.cache-hit != 'true'
run: npm ci

- name: 'Authorize Packaging Org'
shell: bash
run: |
echo ${{ env.DEVHUB_SFDX_URL }} > ./DEVHUB_SFDX_URL.txt
npx sfdx auth:sfdxurl:store --sfdxurlfile ./DEVHUB_SFDX_URL.txt --setalias nebula-logger-packaging --setdefaultdevhubusername
env:
DEVHUB_SFDX_URL: ${{ secrets.DEVHUB_SFDX_URL }}

- name: 'Create Beta Managed Package Version'
run: npm run package:version:create:managed
8 changes: 3 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@
.settings/
.sfdx/
.vscode/
coverage/
nebula-logger/main/default/
nebula-logger/managed-package/
.vim-force.com
tests/apex/
nebula-logger/**/main/default/
test-coverage/
temp/

# NPM
Expand All @@ -16,3 +13,4 @@ yarn.lock

# Files to exclude
*.log
**/lwc/jsconfig.json
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
.sfdx/
.vscode/
scripts/
test-coverage/

# NPM
node_modules/
Expand Down
127 changes: 127 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement via [GitHub Discussions](https://github.com/jongpie/NebulaLogger/discussions).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Loading

0 comments on commit 7c0af6e

Please sign in to comment.