Helpful Resources
Tips, Tricks, and Hacks Share your tips, tricks and hacks for getting the most out of CircleCI Support Solutions The Support Solutions category is here to provide detailed walkthroughs of scenarios our Customer Engineering team encounters and provide a map for users to find their way to success as quickly as possible. Guides, Manuals, and Tutorials This category will host in-depth guides, manuals, and tutorials written by the CircleCI team, Champions, or other knowledge experts. Documentation This is where we can discuss CircleCI Documentation "Docs". This does not replace GitHub, which is where CircleCI Docs is hosted. See the full description below and do's and don'ts for posting here vs GitHub. Integration Resources This category will be used as a compilation of resources we have available about our integrations. If there is an integration you would like to have included that doesn’t have a post, please reply with a comment and we’ll get it set up!
| Topic | Replies | Views | Activity | |
|---|---|---|---|---|
|
List of Resources
Below is a list of the resources we have available that are hosted on Discuss: Self Service Configuration Review This is a manual by @felixshiftellecon on how to evaluate your project’s pipeline configuration for improv… |
|
0 | 513 | July 19, 2023 |
| About the Helpful Resources category |
|
0 | 493 | June 15, 2023 |
| Sunsetting Japanese Documentation pages - April 1, 2025 |
|
0 | 27 | March 27, 2025 |
| Need help with the command script |
|
1 | 695 | August 13, 2024 |
| Triggers in circleci-config-sdk |
|
0 | 18 | July 26, 2024 |
| [Workaround] Auto-cancel redundant builds on the default branch |
|
18 | 7524 | May 17, 2024 |
| Building Images in Docker Executor without Remote Docker |
|
2 | 3216 | April 13, 2024 |
| [Product Update] Org renaming now possible for orgs integrated with GitLab/GitHub App |
|
0 | 297 | February 9, 2024 |
| Working with deploy keys, ssh, and multiple repositories |
|
3 | 5677 | January 17, 2024 |
| CircleCI reporting |
|
0 | 303 | January 10, 2024 |
| Building Multiple pipeline from One Repo/Project |
|
0 | 519 | January 10, 2024 |
| Run builds on CircleCI using a local config file |
|
9 | 8230 | January 3, 2024 |
| Persist_to_workspace vs `save_cache` performance |
|
8 | 15300 | November 3, 2023 |
| Intro to Dynamic Config via Setup Workflows |
|
7 | 17760 | October 18, 2023 |
|
Snapshot Project Metrics
Configuration Review Preparation Snapshot Project Metrics 1) Gather Project Metrics The UI can be used to gather metrics, but when doing multiple config reviews it is helpful to write a script that uses the CircleCI API.… |
|
1 | 513 | September 28, 2023 |
|
Finalize the Config Review
Finalize the Config Review Document Opportunities Document opportunities as they are found throughout the review. You will most likely find yourself referencing all sorts of documentation both internal and external in th… |
|
0 | 403 | July 11, 2023 |
|
Outside a Config File: Project Settings
Outside a Config File Project Settings Security Review project settings to ensure they are set correctly, this can be done via the UI or API. Confirm that the following Advanced settings are toggled off unless needed fo… |
|
0 | 387 | July 11, 2023 |
|
Outside a Config File: Storage Usage
Outside a Config File Storage Usage Caching Inspect the output of caching steps in jobs to ensure cache keys are regularly being found. If not, consider changing the cache key to be less specific or use a fallback key. F… |
|
0 | 447 | July 11, 2023 |
|
Outside a Config File: Secrets Management
Outside a Config File Secrets Management OIDC Attempt to replace any static credentials used in CircleCI for connection to cloud environments with authentication using OIDC tokens. This is not available for all tools so … |
|
0 | 554 | July 11, 2023 |
|
Outside a Config File: Security Settings
Outside a Config File Security Settings Project Settings Review project settings to ensure they are set correctly, this can be done via the UI or API. Confirm that the following Advanced settings are toggled off unless … |
|
0 | 453 | July 11, 2023 |
|
Inside a Config File: Dynamic Configuration
Inside a Config File Dynamic Configuration Why Dynamic Config Dynamic configuration is an easy way to not have to run a full pipeline when it’s not needed, saving credits and time. Most projects can benefit from dynamic … |
|
0 | 581 | July 11, 2023 |
|
Inside a Config File: Reusable Config Opportunities
Inside a Config File Reusable Config Opportunities 1) Config SDK CircleCI config files are written in YAML but that doens’t mean they have to be built using YAML. The Config SDK is a javascript/typescript SDK that can be… |
|
0 | 512 | July 11, 2023 |
|
Inside a Config File: Config Security Opportunities
Inside a Config File Config Security Opportunities 1) OIDC OIDC tokens are available in any job and is a great way to replace static credentials used to connect with cloud services. For example, a Vault instance in AWS. … |
|
0 | 412 | July 11, 2023 |
|
High Level Improvement Opportunities
High Level Improvement Opportunities Record High Level Recommendations High level recommendations are identified opportunities that affect more than one workflow. These opportunities typically exist throughout the organi… |
|
0 | 354 | July 11, 2023 |
|
Review Each Workflow for Improvement Opportunities
Review Each Workflow for Improvement Opportunities 1) Review Job Placement Job order can be the largest impact on workflow duration. Review the workflow for opportunities to run jobs in parallel and note which jobs are b… |
|
0 | 348 | July 11, 2023 |
|
Opportunities for Jobs with High Duration
Review Each Job for Improvement Opportunities Opportunities for Jobs with High Duration 1) Resource Allocation Optimizing the resource classes of your jobs is an easy way to attempt to reduce the duration of a job. Each … |
|
0 | 391 | July 11, 2023 |
|
Execution Environment Opportunities
Review Each Job for Improvement Opportunities Execution Environment Opportunities 1) Resource Allocation Optimizing the resource classes of your jobs is an easy way to ensure credits aren’t being wasted. Each job has a r… |
|
0 | 332 | July 11, 2023 |
|
General Job Opportunities
Review Each Job for Improvement Opportunities General Job Opportunities 1) Review Step Outputs Review each step’s output to ensure it is completing as expected. This is important because steps can silently fail or not wo… |
|
0 | 381 | July 11, 2023 |
|
Review Each Job for Improvement Opportunities
Review Each Job for Improvement Opportunities Why Review Job by Job It is important to review a config file line by line and job by job to ensure no opportunities are missed. After gathering metrics and gathering pain po… |
|
0 | 326 | July 11, 2023 |
|
Review CircleCI Features
Configuration Review Preparation Review CircleCI Features 1) Look at New Features CircleCI releases features at a fast pace and there may be something new that can help your project. Check the changelog for new features … |
|
0 | 378 | July 11, 2023 |