Quickstart
Sign up and authorize Warestack to access your GitHub personal or organization account. Import existing events like pull requests and workflow runs, or begin with a clean slate and start capturing your upcoming codebase’s events. Warestack will automatically track the events needed for keeping your development activities organized in one place.
What to know before you start
⚠️ Without a GitHub connection, Warestack cannot deliver its services.- Each space allows you to connect multiple
GitHubaccounts and organizations with their associated repositories. - By connecting a
GitHubaccount or organization, you allow us to access its data and perform actions on your behalf according to the permissions granted by the authorization scope. You will be able to authorize additional accounts and organizations later.
Get started checklist
✅ Follow these steps to set up and maximize the efficiency of your space. If you encounter any issues, refer to the relevant documentation linked under each action or contact support for assistance.
- Grant access via GitHub OAuth: Connect Your Platform via GitHub OAuth: Now that your profile and space are set up, connect your GitHub account by granting access to your account and selected organizations. This OAuth process allows Warestack to retrieve user details and list the organizations you have access to, even if you’re not an admin. This step is essential for recognizing accessible organizations along with their permissions. You can revoke access anytime, following the GitHub documentation Reviewing your authorized OAuth apps page.
- Create a space: After setting your profile, create a space in Warestack to manage your GitHub accounts and organizations with the associated repositories. Spaces allow you to consolidate all workflows and events in one place, enabling efficient management of code activities, task tracking, and collaboration.
- Install the Warestack GitHub app: To enable real-time monitoring, install the Warestack GitHub to your account or one of the granted organizations from the previous step. The GitHub app is responsible for tracking events like pull requests, workflow runs, and deployments across your selected repositories. This installation requires admin permissions for each organization you want to monitor. You can review and revoke access anytime, following the GitHub documentation Reviewing and revoking authorization of GitHub Apps page.
- Import existing events: To ensure your space is populated with relevant activity, Warestack allows you to import past events from selected repositories. Choose the repositories you want to track, specify a time frame (e.g., past week), and select the types of events to import, such as issues, pull requests, and workflow runs. This way, you’ll start with a comprehensive view of recent activities, making it easier to get started without an empty space.
- Invite a team member: Collaborate more effectively by inviting your team members to join your space. Together,
you can manage daily operational tasks seamlessly. Go to
Space settingsand navigate to the team management section. - Set your profile: Upon signing up, you’ll start by personalizing your profile to tailor Warestack to your role and daily tasks. Select your role (e.g., DevOps Engineer) and specify key tasks you manage, such as code review, workflow monitoring, or metrics tracking. This setup helps Warestack provide a customized experience aligned with your responsibilities.
- Set a platform repository: Set a repository as the platform repository within a GitHub installation and index its workflows. The indexed workflows become accessible for reference in other repositories within the same space. Only one repository can hold the platform status at a time, and this action overrides any previously set repository. This approach minimizes duplication, ensures consistency across the space, and establishes the repository as the single source of truth for shared workflows.
What are the events monitored by the Warestack GitHub app?
Here is a list of events that Warestack monitors for you.
| Event | Description |
|---|---|
| Branch protection rules | Monitors the creation, deletion, or modification of branch protection rules to ensure your code branches are safeguarded with the correct policies. |
| Deployments | Tracks repository deployments when they are initiated or deleted, providing insights into the deployment process and its outcomes. |
| Deployment reviews | Monitors when deployment reviews are requested, approved, or rejected, ensuring the review process is transparent and efficient. |
| Issues | Monitors the full lifecycle of issues, including creation, editing, deletion, transfer, pinning, unpinning, closing, reopening, assignment, labeling, milestone updates, and locking. This helps keep issue management organized and traceable. |
| Membership | Keeps track of when team memberships are added or removed, ensuring team composition and permissions remain accurate. |
| Pull request reviews | Logs submissions, edits, and dismissals of pull request reviews, facilitating better oversight and collaboration in code reviews. |
| Pull request review threads | Detects when review threads are resolved or unresolved, helping teams track discussions and feedback on code changes. |
| Team management | Monitors the creation or modification of teams within a repository, ensuring that team structures and roles align with project needs. |
| Workflow jobs | Keeps tabs on workflow jobs as they are queued, progress, complete, or wait within a repository, allowing teams to manage job status efficiently. |
| Branch protection configuration | Tracks when branch protections are enabled or disabled, ensuring your repository settings are consistently applied and secure. |
| Check runs | Monitors when check runs are created, requested, re-requested, or completed, providing a clear view of code validation activities. |
| Deployment protection rules | Monitors when protection rules are requested for an environment to maintain compliance and security during deployments. |
| Deployment status | Updates related to the deployment statuses made via the API, enabling visibility into the current state of deployments. |
| Issue comments | Tracks the creation, editing, and deletion of comments on issues, ensuring that discussions and feedback are managed and preserved. |
| Milestones | Monitors when milestones are created, opened, closed, edited, or deleted, allowing teams to track project progress against set goals. |
| Repository membership | Monitors the addition, removal, or changes in permissions for repository collaborators to ensure appropriate access control. |
| Pull requests | Tracks a range of pull request activities including assignment, enabling/disabling auto-merge, closing, converting to draft, editing, labeling, locking, opening, readying for review, reopening, synchronizing, unlabeled, and unlocking, providing comprehensive oversight of code changes. |
| Pull request review comments | Monitors the creation, editing, and deletion of comments on pull request diffs, ensuring the review process is detailed and clear. |
| Push events | Logs Git pushes to a repository, tracking code updates and changes in real-time. |
| Repository rulesets | Monitors the creation, deletion, or editing of repository rulesets to ensure that rules are consistently applied across your repositories. |
| Team management | Tracks when teams are created, deleted, edited, or added/removed from a repository, supporting effective team and project management. |
| Workflow runs | Monitors when workflow runs are requested or completed, giving visibility into automation processes and their outcomes. |
Do you have issues with account creation?
🚧 Warestack is currently in its beta phase and is still being actively developed.As a result, you may encounter occasional errors or unexpected behavior. If you experience any issues, please don’t hesitate to contact us at support@warestack.com.
Do you want to delete your account?
We’ll be sad to see you go! If you wish to delete your Warestack account, navigate to the account settings and select the delete account option.
Please note that:
- Deleting a space will revoke access for all associated team members, and any related workflows or resources may be lost.
- You cannot delete a space if it is your only assigned space.
- You may not have permission to delete the space if you are only a viewer.
- You must manually uninstall the GitHub App from your GitHub account.
⚠️ Account deletion is permanent and cannot be undone.If you experience any issues, please reach out to us at support@warestack.com.