Skip to content

Commit 09c245b

Browse files
committed
update README and action name uses in test yml
1 parent c1ab463 commit 09c245b

5 files changed

Lines changed: 127 additions & 1 deletion

File tree

.github/workflows/test-action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010

1111
- name: Test Local Action
1212
id: testing-distribution
13-
uses: ./
13+
uses: appcircleio/appcircle-testing-distribution-githubaction
1414
with:
1515
accessToken: ${{ secrets.AC_ACCESS_TOKEN }}
1616
profileID: ${{ secrets.AC_PROFILE_ID }}

README.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
## Appcircle Testing Distribution
2+
3+
Appcircle simplifies the distribution of builds to test teams with an extensive
4+
platform for managing and tracking applications, versions, testers, and teams.
5+
Appcircle integrates with enterprise authentication mechanisms such as LDAP and
6+
SSO, ensuring secure distribution of testing packages. Learn more about
7+
Appcircle testing distribution. Learn more about
8+
[Appcircle testing distribution](https://appcircle.io/testing-distribution?utm_source=github&utm_medium=plugin&utm_campaign=testing_distribution)
9+
10+
Appcircle's test distribution extension enables developers to create test groups
11+
and share builds with them, utilizing enterprise-grade authentication methods.
12+
With the GitHub actions marketplace, this module will be accessible directly
13+
from the actions.
14+
15+
## Exploring Testing Distribution
16+
17+
Testing distribution is the process of distributing test builds to designated
18+
test groups or individuals. This process allows developers to gather quick
19+
feedback, identify bugs, and ensure the quality of software applications before
20+
releasing them to customers. Appcircle's test distribution module enables
21+
developers to create test groups and share builds with them, utilizing
22+
enterprise-grade authentication methods.
23+
24+
## Benefits of Using Testing Distribution
25+
26+
1. **Simplified Binary Distribution**.
27+
- **Skip Traditional Stores:** Share .xcarchive .IPA, APK, AAB, Zip, files
28+
directly, avoiding the need to use App Store TestFlight or Google Play
29+
Internal Testing.
30+
2. **Streamlined Workflow:**
31+
- **Automated Processes:** Platforms like Appcircle automate the distribution
32+
process, saving time and reducing manual effort.
33+
- **Seamless Integration:** Integrates smoothly with existing DevOps
34+
pipelines, enabling efficient build and distribution workflows.
35+
3. **Enhanced Security:**
36+
- **Controlled Access:** Set specific permissions for who can access the test
37+
builds using enterprise authentication methods such as LDAP & SSO.
38+
- **Confidentiality:** Ensures that only authorized testers have access to
39+
the builds, protecting sensitive information.
40+
4. **Efficient Resource Management:**
41+
- **Targeted Testing:** Allows the creation of specific test groups, ensuring
42+
that the right people are testing the right features.
43+
- **Optimized Testing:** Helps in allocating resources effectively, leading
44+
to better utilization of testing resources.
45+
5. **Reduced Time to Market:**
46+
- **Eliminates Approval Delays:** By bypassing store approval processes,
47+
developers can distribute builds directly to testers, speeding up the
48+
testing cycle.
49+
- **Continuous Delivery:** Supports continuous delivery practices, enabling
50+
faster iterations and quicker releases.
51+
6. **Faster Feedback Loop:**
52+
- **Quick Issue Identification:** Distributing test builds quickly allows
53+
developers to gather immediate feedback, identify bugs, and address issues
54+
early in the development cycle.
55+
- **Improved Quality:** Continuous testing helps ensure the software meets
56+
quality standards before release, reducing the likelihood of post-release
57+
issues.
58+
7. **Cost-Effective:**
59+
- **Reduced Overheads:** Automating the distribution reduces the need for
60+
manual intervention, cutting down operational costs.
61+
- **Efficient Bug Fixes:** Early detection and fixing of bugs prevent costly
62+
fixes later in the development process.
63+
8. **Enhanced User Experience:**
64+
- **Better Quality Control:** Ensures that end users receive a more stable
65+
and polished product.
66+
- **Customer Satisfaction:** By delivering higher quality software, customer
67+
satisfaction and trust in the product increase.
68+
69+
Overall, using testing distribution in mobile DevOps significantly enhances the
70+
efficiency, security, and effectiveness of the software development process,
71+
leading to better products and faster delivery times.
72+
73+
### Testing Distribution
74+
75+
In order to share your builds with testers, you can create distribution profiles
76+
and assign testing groups to the distribution profiles.
77+
78+
![Distribution Profile](images/distribution-start.png)
79+
80+
### Generating/Managing the Personal API Tokens
81+
82+
To generate a Personal API Token, follow these steps:
83+
84+
1. Go to the My Organization screen (the second option at the bottom left).
85+
2. You'll find the Personal API Token section in the top right corner.
86+
3. Press the "Generate Token" button to generate your first token.
87+
88+
![Token Generation](images/PAT.png)
89+
90+
## Getting Started with the Action: Usage Guide
91+
92+
To share your builds with testers, you can create distribution profiles and
93+
assign testing groups to these profiles. Add a step to your pipeline for 'Test
94+
Local Action' with the appropriate information.
95+
96+
```yaml
97+
- name: Test Local Action
98+
id: testing-distribution
99+
uses: appcircleio/appcircle-testing-distribution-githubaction
100+
with:
101+
accessToken: ${{ secrets.AC_ACCESS_TOKEN }} # Your Appcircle Access Token
102+
profileID: ${{ secrets.AC_PROFILE_ID }} # ID of your Appcircle Distribution Profile
103+
appPath: ${{ secrets.APP_PATH }} # Path to your iOS .ipa or .xcarchive, or Android APK or App Bundle
104+
message: ${{ secrets.MESSAGE }}
105+
```
106+
107+
### Leveraging Environment Variables
108+
109+
Utilize environment variables seamlessly by substituting the parameters with
110+
`${{ envs.VARIABLE_NAME }}` in your task inputs. The extension automatically
111+
retrieves values from the specified environment variables within your pipeline.
112+
113+
Efficiently distribute test binaries or beta versions using Appcircle, featuring
114+
seamless IPA and APK distribution capabilities. Streamline your testing process
115+
with our versatile tool designed to optimize your distribution workflow. If you
116+
need support or more information, please
117+
[contact us](https://appcircle.io/contact?utm_source=github&utm_medium=plugin&utm_campaign=testing_distribution)
118+
119+
### Reference
120+
121+
- For details on generating an Appcircle Personal Access Token, visit
122+
[Generating/Managing Personal API Tokens](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens?utm_source=github&utm_medium=plugin&utm_campaign=testing_distribution)
123+
124+
- To create or learn more about Appcircle testing and distribution profiles,
125+
please refer to
126+
[Creating or Selecting a Distribution Profile](https://docs.appcircle.io/distribute/create-or-select-a-distribution-profile?utm_source=github&utm_medium=plugin&utm_campaign=testing_distribution)

images/PAT.png

161 KB
Loading

images/distribution-start.png

75.4 KB
Loading

images/extension-icon.png

47.7 KB
Loading

0 commit comments

Comments
 (0)