Skip to content

Commit

Permalink
feat: fulfillment event processor
Browse files Browse the repository at this point in the history
WIP: stub in fulfillments processor package
  • Loading branch information
blefebvre committed Jan 30, 2024
1 parent 815b447 commit 696a9e4
Show file tree
Hide file tree
Showing 17 changed files with 727 additions and 2 deletions.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions packages/spacecat-fulfillments-processor/.jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"plugins": [],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
6 changes: 6 additions & 0 deletions packages/spacecat-fulfillments-processor/.mocha-multi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"reporterEnabled": "spec,xunit",
"xunitReporterOptions": {
"output": "junit/test-results.xml"
}
}
9 changes: 9 additions & 0 deletions packages/spacecat-fulfillments-processor/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
coverage/
node_modules/
junit/
test/
docs/
logs/
test-results.xml
renovate.json
.*
10 changes: 10 additions & 0 deletions packages/spacecat-fulfillments-processor/.nycrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"reporter": [
"lcov",
"text"
],
"check-coverage": true,
"lines": 100,
"branches": 97,
"statements": 100
}
17 changes: 17 additions & 0 deletions packages/spacecat-fulfillments-processor/.releaserc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
module.exports = {
extends: "semantic-release-monorepo",
plugins: [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@semantic-release/changelog", {
"changelogFile": "CHANGELOG.md",
}],
"@semantic-release/npm",
["@semantic-release/git", {
"assets": ["package.json", "CHANGELOG.md"],
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
}],
["@semantic-release/github", {}],
],
branches: ['main'],
};
59 changes: 59 additions & 0 deletions packages/spacecat-fulfillments-processor/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# [@adobe/spacecat-shared-example-v1.2.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-example-v1.2.2...@adobe/spacecat-shared-example-v1.2.3) (2024-01-24)


### Bug Fixes

* **deps:** update dependency @adobe/helix-shared-wrap to v2.0.1 ([#103](https://github.com/adobe/spacecat-shared/issues/103)) ([54286e8](https://github.com/adobe/spacecat-shared/commit/54286e8e3f99a4fdf82d029c475cad0bad602497))

# [@adobe/spacecat-shared-example-v1.2.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-example-v1.2.1...@adobe/spacecat-shared-example-v1.2.2) (2024-01-23)


### Bug Fixes

* use released official version of monorepo after fix ([#101](https://github.com/adobe/spacecat-shared/issues/101)) ([39297be](https://github.com/adobe/spacecat-shared/commit/39297be9f7e335925a8ace1b1a19efad01ba3628))

# [@adobe/spacecat-shared-example-v1.2.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-example-v1.2.0...@adobe/spacecat-shared-example-v1.2.1) (2024-01-23)


### Bug Fixes

* missing module releaserc ([0ec70ba](https://github.com/adobe/spacecat-shared/commit/0ec70ba171edd66f4aa4e3770cc9b2a3e29d752c))
* monorepo extends overwrites config ([#99](https://github.com/adobe/spacecat-shared/issues/99)) ([fea357f](https://github.com/adobe/spacecat-shared/commit/fea357f105d96e3d9dbf87687c26bc34b21f8b5d))

# [@adobe/spacecat-shared-example-v1.2.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-example-v1.1.0...@adobe/spacecat-shared-example-v1.2.0) (2024-01-12)


### Bug Fixes

* github org ([02f86c3](https://github.com/adobe/spacecat-shared/commit/02f86c351b2b1ab99ce5aca7fd5e6af2246c0efd))


### Features

* site delivery type ([#77](https://github.com/adobe/spacecat-shared/issues/77)) ([005bc38](https://github.com/adobe/spacecat-shared/commit/005bc388ed6ab0f82c8b0f562d4c1f4c0d1e2894))

# [@adobe/spacecat-shared-example-v1.1.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-example-v1.0.0...@adobe/spacecat-shared-example-v1.1.0) (2023-11-29)


### Features

* add guards and use spacecat-shared-utils ([#6](https://github.com/adobe/spacecat-shared/issues/6)) ([27143cf](https://github.com/adobe/spacecat-shared/commit/27143cf2d4a439f1b5904e62756e59e501b3f67d))

# @adobe/spacecat-shared-example-v1.0.0 (2023-11-27)


### Bug Fixes

* bogus change to force release ([e77e830](https://github.com/adobe/spacecat-shared/commit/e77e8305c96ac2504aeb22af44d45cb4acbcae56))
* package name to "adobe" ([475434e](https://github.com/adobe/spacecat-shared/commit/475434e6619c2128ba1a8308a4eed23cf3d40691))
* remove unneeded import (force release) ([49964f9](https://github.com/adobe/spacecat-shared/commit/49964f99906d5a0fafeb68b460cb19f98a51fc86))
* repo reference ([881487d](https://github.com/adobe/spacecat-shared/commit/881487dce4c840ac2bf02a285f17cac511d39c88))
* roll-back esm monorepo ([ab77518](https://github.com/adobe/spacecat-shared/commit/ab775187dc79a7f2cdb0ca4fa31198202be78143))
* set package version to semantic, remove dev deps ([bf62c5f](https://github.com/adobe/spacecat-shared/commit/bf62c5fe013dbbb7425eb21cffa23e7f01322aee))
* set to semantic-release versioning ([9209799](https://github.com/adobe/spacecat-shared/commit/92097995b657207996dd6a35277fdfcd3f3e8fb9))
* variouss ([ea9d44f](https://github.com/adobe/spacecat-shared/commit/ea9d44f6071c1a53d2c31515966e7cdf44be7ae9))


### Features

* test ([bd3cc5d](https://github.com/adobe/spacecat-shared/commit/bd3cc5df89ccde75b86b000e8495893f4b099b5b))
74 changes: 74 additions & 0 deletions packages/spacecat-fulfillments-processor/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Adobe Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
74 changes: 74 additions & 0 deletions packages/spacecat-fulfillments-processor/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributing to Project Franklin

This project (like almost all of Project Franklin) is an Open Development project and welcomes contributions from everyone who finds it useful or lacking.

## Code Of Conduct

This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to cstaub at adobe dot com.

## Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. [Sign our CLA](http://opensource.adobe.com/cla.html)! You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!

## Things to Keep in Mind

This project uses a **commit then review** process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.

For other contributors, a maintainer of the project has to approve the pull request.

# Before You Contribute

* Check that there is an existing issue in GitHub issues
* Check if there are other pull requests that might overlap or conflict with your intended contribution

# How to Contribute

1. Fork the repository
2. Make some changes on a branch on your fork
3. Create a pull request from your branch

In your pull request, outline:

* What the changes intend
* How they change the existing code
* If (and what) they breaks
* Start the pull request with the GitHub issue ID, e.g. #123

Lastly, please follow the [pull request template](.github/pull_request_template.md) when submitting a pull request!

Each commit message that is not part of a pull request:

* Should contain the issue ID like `#123`
* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue



## Coding Styleguides

We enforce a coding styleguide using `eslint`. As part of your build, run `npm run lint` to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide.

You can fix some of the issues automatically by running `npx eslint . --fix`.

## Commit Message Format

This project uses a structured commit changelog format that should be used for every commit. Use `npm run commit` instead of your usual `git commit` to generate commit messages using a wizard.

```bash
# either add all changed files
$ git add -A
# or selectively add files
$ git add package.json
# then commit using the wizard
$ npm run commit
```

# How Contributions get Reviewed

One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub.

# Release Management

The project's committers will release to the [Adobe organization on npmjs.org](https://www.npmjs.com/org/adobe).
Please contact the [Adobe Open Source Advisory Board](https://git.corp.adobe.com/OpenSourceAdvisoryBoard/discuss/issues) to get access to the npmjs organization.

The release process is fully automated using `semantic-release`, increasing the version numbers, etc. based on the contents of the commit messages found.
Loading

0 comments on commit 696a9e4

Please sign in to comment.