Skip to content

Commit a523a41

Browse files
committed
Merge branch 'main' of https://github.com/VinceFINET/OrgCheck into main
2 parents c6ddfab + a967f3d commit a523a41

File tree

3 files changed

+98
-6
lines changed

3 files changed

+98
-6
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
on:
15+
push:
16+
branches: [ main, release-1.9 ]
17+
pull_request:
18+
# The branches below must be a subset of the branches above
19+
branches: [ main ]
20+
schedule:
21+
- cron: '17 9 * * 1'
22+
23+
jobs:
24+
analyze:
25+
name: Analyze
26+
runs-on: ubuntu-latest
27+
permissions:
28+
actions: read
29+
contents: read
30+
security-events: write
31+
32+
strategy:
33+
fail-fast: false
34+
matrix:
35+
language: [ 'javascript' ]
36+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37+
# Learn more about CodeQL language support at https://git.io/codeql-language-support
38+
39+
steps:
40+
- name: Checkout repository
41+
uses: actions/checkout@v2
42+
43+
# Initializes the CodeQL tools for scanning.
44+
- name: Initialize CodeQL
45+
uses: github/codeql-action/init@v1
46+
with:
47+
languages: ${{ matrix.language }}
48+
# If you wish to specify custom queries, you can do so here or in a config file.
49+
# By default, queries listed here will override any specified in a config file.
50+
# Prefix the list here with "+" to use these queries and those in the config file.
51+
# queries: ./path/to/local/query, your-org/your-repo/queries@main
52+
53+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
54+
# If this step fails, then you should remove it and run the build manually (see below)
55+
- name: Autobuild
56+
uses: github/codeql-action/autobuild@v1
57+
58+
# ℹ️ Command-line programs to run using the OS shell.
59+
# 📚 https://git.io/JvXDl
60+
61+
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
62+
# and modify them (or add more) to build your code if your project
63+
# uses a compiled language
64+
65+
#- run: |
66+
# make bootstrap
67+
# make release
68+
69+
- name: Perform CodeQL Analysis
70+
uses: github/codeql-action/analyze@v1

docs/_layouts/default.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
2323
<p>{{ site.description | default: site.github.project_tagline }}</p>
2424

2525
{% if site.github.is_project_page %}
26-
<p class="view"><a href="{{ site.github.repository_url }}" target="_blank">View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
26+
<p class="view"><a href="{{ site.github.repository_url }}" target="_blank" rel="external noopener noreferrer" >View the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
2727
{% endif %}
2828

2929
{% if site.github.is_user_page %}
30-
<p class="view"><a href="{{ site.github.owner_url }}" target="_blank">View My GitHub Profile</a></p>
30+
<p class="view"><a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">View My GitHub Profile</a></p>
3131
{% endif %}
3232

3333
<p>
@@ -60,7 +60,7 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
6060
</section>
6161
<footer>
6262
{% if site.github.is_project_page %}
63-
<p>This project is maintained by <a href="{{ site.github.owner_url }}" target="_blank">{{ site.github.owner_name }}</a></p>
63+
<p>This project is maintained by <a href="{{ site.github.owner_url }}" target="_blank" rel="author noopener noreferrer">{{ site.github.owner_name }}</a></p>
6464
{% endif %}
6565
<p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
6666
</footer>

docs/install.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permalink: /installation/
1212
**OrgCheck** is a Salesforce application which can be installed on **any** Salesforce organization **very easily**. No additional infrastructure is required. No additional license. Simple as A.B.C.
1313

1414

15-
## A) URLs for the installation
15+
## Step 1: URLs for the installation
1616

1717
Go to one of the following URLs depending on the nature of the organization you want to install **OrgCheck**.
1818

@@ -27,7 +27,7 @@ After selecting the previous URL, you were redirected to Salesforce servers.
2727
If you were not yet authenticated, you will have to sign on using your credentials.
2828

2929

30-
## B) Install the package
30+
## Step 2: Install the package
3131

3232
Just like an AppExchange application you have to:
3333
- Select the profiles -- we recommand to select **Admins Only**
@@ -38,7 +38,7 @@ For some orgs that have Apex class not compiling, you can install the package wi
3838
![Installation Notice screenshot](../images/screenshots/OrgCheck-Screenshot-Install.png)
3939

4040

41-
## C) Permission Set assignment
41+
## Step 3: Permission Set assignment
4242

4343
Once installed, go to your org and assign your Salesforce user to the Permission Set called "OrgCheck Users".
4444

@@ -58,3 +58,25 @@ We are also able to **push a new version** of the package in your org, to make s
5858
We made the choice to use a specific **namespace** for this package, which is __OrgCheck__ of course, so that you can identify faster components of this package when browsing the metadata of your org (additionally to the naming convention).
5959

6060
Finally, the content of the application can be modified in your org (using the Salesforce Dev Console) in case you find a solution to a bug. Do not forget that every component of this package is under the MIT licence.
61+
62+
63+
## Known issues
64+
65+
### I can't install the package because some Apex class are not compiling
66+
- Our package does **NOT include ANY Apex class**.
67+
- It is more likely a **existing Apex class** in the org you want to analyze that **does not compile** (it happens!).
68+
- In that case, you can still install the package BUT you will have to specify during the installation process that you only want to validate the classes that are included in the package. This can be done via the **advanced setting when installing the app**.
69+
70+
### I can't see the OrgCheck application, even if I am SysAdmin and/or are assigned the OrgCheck Permission set
71+
- The app is called "**OrgCheck**" obviously, maybe you spell it wrong?
72+
- Double check that you are assigned to the **permission set** (just in case you missed that part).
73+
- You should see the application definitly!
74+
75+
### I have the same error on EVERY tabs when the tool is accessing the API: INVALID_SESSION_ID: This session is not valid for use with the REST API
76+
In case you have enabled the "**API Client Whitelisting**" feature, you will need to:
77+
- Create another permission set (don't modify the OrgCheck permission because on the next release your setting will be overwritten).
78+
- In this permission set, check the system permission called "**Use any API Client**" (which appears ONLY if you activate the "**API CLient Whitelisting**" feature -- that's why we can't add it to everybody).
79+
- And assign your user to this additional permission set.
80+
For more information, you can check that closed issue: https://github.com/VinceFINET/OrgCheck/issues/118
81+
82+

0 commit comments

Comments
 (0)