{"id":29173381,"url":"https://github.com/mixcore/sdk-client","last_synced_at":"2025-07-01T14:14:47.707Z","repository":{"id":293432038,"uuid":"974837823","full_name":"mixcore/sdk-client","owner":"mixcore","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-21T18:12:52.000Z","size":404,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-21T19:24:42.934Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mixcore.png","metadata":{"files":{"readme":".github/README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-29T11:36:33.000Z","updated_at":"2025-06-21T18:12:55.000Z","dependencies_parsed_at":"2025-06-09T04:27:33.772Z","dependency_job_id":"709772d1-8234-41b2-8218-b4e232fb9f29","html_url":"https://github.com/mixcore/sdk-client","commit_stats":null,"previous_names":["mixcore/sdk-client"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mixcore/sdk-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mixcore%2Fsdk-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mixcore%2Fsdk-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mixcore%2Fsdk-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mixcore%2Fsdk-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mixcore","download_url":"https://codeload.github.com/mixcore/sdk-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mixcore%2Fsdk-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262978827,"owners_count":23394022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T14:14:44.923Z","updated_at":"2025-07-01T14:14:47.699Z","avatar_url":"https://github.com/mixcore.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Actions Setup for @mixcore/sdk-client\n\nThis repository includes automated workflows for building, testing, and publishing the `@mixcore/sdk-client` package to npm.\n\n## Workflows\n\n### 1. CI Workflow (`ci.yml`)\n- **Trigger**: Pull requests and pushes to main branch\n- **Purpose**: Runs tests, linting, type checking, and builds to ensure code quality\n- **Steps**:\n  - Install dependencies\n  - Type checking\n  - Linting\n  - Build packages\n  - Run tests with coverage\n\n### 2. Release Workflow (`release.yml`)\n- **Trigger**: Pushes to main branch (when changesets are present)\n- **Purpose**: Automatically publishes packages to npm using changesets\n- **Features**:\n  - Creates Release PRs when changesets are present\n  - Automatically publishes to npm when Release PRs are merged\n  - Generates changelogs\n\n### 3. Manual Release Workflow (`manual-release.yml`)\n- **Trigger**: Manual workflow dispatch from GitHub Actions tab\n- **Purpose**: Allows manual releases with version bump selection\n- **Options**: patch, minor, or major version bumps\n\n## Setup Instructions\n\n### 1. NPM Token Setup\n1. Go to [npmjs.com](https://www.npmjs.com) and log in\n2. Navigate to Access Tokens in your account settings\n3. Create a new \"Automation\" token with \"Read and write\" permissions\n4. In your GitHub repository, go to Settings → Secrets and variables → Actions\n5. Add a new repository secret named `NPM_TOKEN` with your npm token value\n\n### 2. Repository Configuration\nEnsure your repository has the following branch protection rules for `main`:\n- Require pull request reviews\n- Require status checks to pass (CI workflow)\n- Require up-to-date branches\n\n## Usage\n\n### Automated Releases (Recommended)\n1. Create a changeset for your changes:\n   ```bash\n   pnpm exec changeset\n   ```\n2. Follow the prompts to select packages and version bump type\n3. Commit and push the changeset file\n4. The workflow will create a Release PR\n5. When the Release PR is merged, the package will be automatically published\n\n### Manual Releases\n1. Go to the Actions tab in your GitHub repository\n2. Select \"Manual Release\" workflow\n3. Click \"Run workflow\"\n4. Choose the version bump type (patch/minor/major)\n5. The workflow will create a version bump and publish to npm\n\n## Package Configuration\n\nThe package is configured with:\n- **Public access**: Set in both `package.json` (`publishConfig.access: \"public\"`) and changeset config\n- **Build before publish**: The `prepublishOnly` script ensures the package is built before publishing\n- **Dist files**: Only the `dist/` directory is included in the published package\n\n## Troubleshooting\n\n### Common Issues\n1. **NPM Token Invalid**: Ensure the `NPM_TOKEN` secret is set correctly and has write permissions\n2. **Build Failures**: Check that all tests pass locally before pushing\n3. **Changeset Issues**: Ensure changeset files are properly formatted and committed\n\n### Debugging\n- Check the Actions tab for detailed logs\n- Verify that all dependencies are properly installed\n- Ensure the build process completes successfully locally\n\n## Security Notes\n- The `NPM_TOKEN` secret is only accessible to workflow runs on the main branch\n- The workflows use the latest stable versions of actions with specific version pinning\n- Dependencies are cached to improve performance and security ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmixcore%2Fsdk-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmixcore%2Fsdk-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmixcore%2Fsdk-client/lists"}